同步

Author: SenLiangpi

.babelrc

@@ -1,14 +1,3 @@
-.DS_Store
-node_modules/
-/dist/
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Editor directories and files
-.idea
-.vscode
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
+node_modules
+dist
+.history

.editorconfig

@@ -1,27 +1,50 @@
 <!--
  * @Author: PiPi
- * @Email: [email protected]
  * @Github: https://github.com/SenLiangpi
- * @Website: https://senliangpi.github.io/blog/#/
- * @Date: 2020-05-20 09:46:48
+ * @Email: [email protected]
+ * @Date: 2019-06-17 15:38:23
  * @LastEditors: Pi Patle
- * @LastEditTime: 2020-10-28 10:26:05
---> 
+ * @LastEditTime: 2020-10-28 10:09:12
+ -->
 # web-logging 日志记录
-web-logging是一个纯JavaScript编写的 前端日志管理。主要是为了解决现在使用webpack打包后的项目导致的 错误信息不易追踪的问题。web-logging日志存储为近30天的记录。本庫依賴 amx-indexeddb。
-* 可自己手動創建日志記錄。
-* 已自動抓取 JavaScript 及 vue 中的報錯信息 日志記錄。（vue的錯誤需要使用vue版才可以抓取）
-* 如需要自定義功能可自行進行二次開發。
+web-logging是一个纯JavaScript编写的 前端日志管理，用於檢測前端的日志系統。web-logging日志存储为近15天的记录。本庫依賴 amx-indexeddb。
 
 支持Amx技术：
 * IndexedDB - IndexedDB 是一个用于在浏览器中储存较大数据结构的 Web API, 并提供索引功能以实现高性能查找. 像其他基于 SQL 的 关系型数据库管理系统 (RDBMS) 一样, IndexedDB 是一个事务型的数据库系统. 然而, 它是使用 JavaScript 对象而非列数固定的表格来储存数据的.
 
 github : https://github.com/SenLiangpi/web-logging
 
-web-logging 介紹及使用方法
-https://github.com/SenLiangpi/web-logging/tree/master/src/web-logging
-
-web-logging-vue web-logging的vue版本 介紹及使用方法
-https://github.com/SenLiangpi/web-logging/tree/master/src/web-logging-vue
-
+# 用法
+安装 npm i web-logging
+在所需点引入 web-logging
+```javascript
+  //web-logging 供三个方法 webLoggingIn 初始化 webLoggingWrite 写入 webLoggingList读出
+  import { webLoggingIn, webLoggingWrite, webLoggingList } from 'web-logging'
+```
+# API
+webLoggingIn(Boolean)
+```javascript
+  //webLogging會在body中創建dom 以提供 logging 日志記錄的查看 ，傳入參數 true 或 false ，true為允許 將渲染dom false 為不允許 將不會渲染
+  webLoggingIn(Boolean)
+```
+webLoggingWrite(json)
+```javascript
+/**
+   * { 
+   * logName: '用于标识日志，例如请求日志、标准错误、标准输出等。',
+   * remarks: '备注'
+   * }
+   */
+  webLoggingWrite({logName:'业务逻辑',remarks: '外部引入方法'})
+```
+webLoggingList(startDate,endDate)
+```javascript
+//startDate 开始时间 endDate结束时间 时间段查询 如果不传值则查询全部
+//如果传开始时间 就查询开始时间之后所有的数据 如果传结束时间就查询结束时间之后记录的所有数据 已对应设备的时间为准
+  webLoggingList(startDate,endDate).then((result) => {
+    console.log(result)
+  }).catch((err) => {
+    console.log(err)
+  });
+```
 皮皮研究所製作