lee_web_track_sdk 0.0.9 → 0.0.11

package/README.md

@@ -14,7 +14,7 @@
 该项目为针对**FR24 前端组**项目的一款**全链路**埋点采集、上报 SDK，支持在以下环境使用：
 
 - 原生 JavaScript 开发且运行于浏览器环境下的项目
-- Vue、React 等前端框架开发且运行于浏览器环境下的项目
+- Vue、React（暂未支持） 等前端框架开发且运行于浏览器环境下的项目
 
 ## 🚀 支持事件
 
@@ -47,43 +47,46 @@ yarn install
 
 ```js
 // main.js
-import FrTrack from 'fr_web_track_sdk/dist/esm';
-
-// or
-
-const FrTrack = require('fr_web_track_sdk');
+import FrSDK from 'fr-web-monitor-sdk';
 ```
 
 ### 3. 使用
 
 ```js
-const frTrack = new FrTrack({
+const webSDK = FrSDK.init({
   // ...options
 });
 
-frTrack.setUser('');
-frTrack.setRouteMode('history');
+webSDK.setUser('');
+
+export const frTrack = webSDK.$track;
 ```
 
 ## 🔧 配置项 Options
 
 ```typescript
-interface CustomOptions {
+interface Options {
   project_name: string;
   report_url: string;
-  app_version?: string;
-  auto_pv?: boolean;
-  maxCacheSize?: number;
-  maxCacheTime?: number;
+  app_version: string;
+  adapter: 'web' | 'miniProgram';
+  maxCacheSize: number;
+  maxCacheTime: number;
+  maxTimeout: number;
+  plugins: {
+    type: 'track' | 'error' | 'performance';
+    options: Record<string, unknown>;
+  }[];
 }
 ```
 
 - `project_name`：**必选**，项目名称
 - `report_url`：**必选**，上报地址
 - `app_version`：**非必选**，项目版本，默认 unknown
-- `auto_pv`：**非必选**，是否自动捕获 pv，默认 false
+- `adapter`：**非必选**，运行环境，默认 web
 - `maxCacheSize`：**非必选**，最大缓存事件阈值，达到阈值自动上报，默认 15
 - `maxCacheTime`：**非必选**，最大缓存时间阈值，达到阈值自动上报，默认 300000 毫秒（5 分钟）
+- `maxTimeout`：**非必选**，最大上报超时时间阈值，达到阈值中止上报，默认 30000 毫秒（30 秒）
 
 ## 🔧 实例方法