超级码埋点 cjm-tracker

Features

• [x] 采用gif图片上报
• [x] 支持自定义上报类型
• [x] 支持自定义上报参数
• [x] 支持自定义上报地址

Install

$ npm install

$ npm run build

Usage

1. 采用script标签引入的方式: 注意需要带上版本号

<script src="https://unpkg.com/cjm-tracker@{version}/dist/umd/cjm-tracker.min.js"></script>

2. 采用npm引入的方式

$ npm install cjm-tracker

// 在项目中引入
import {CjmTracker, CjmEventEnum, CjmUserSourceEnum} from 'cjm-tracker';

window.cjmTracker = new CjmTracker({
  reportUrl: 'http://localhost:3000/', // 上报地址
  debug: false, // 是否开启调试模式
}, {
  appName: 'xxx',
  appVersion: 'x.x.x',
  appId: 'xxx',
});

// 在获取到用户信息后添加配置, 例如:
const userInfo = await getUserInfo();
window.cjmTracker.setConfig({
  userAccount: userInfo.account,
  userRole: userInfo.role,
  userArea: userInfo.area,
  userSource: CjmUserSourceEnum.pc,
});

// 在需要上报的地方调用
window.cjmTracker.track({
  event: CjmEventEnum.click_feature, // 上报类型， 默认为 click_feature，可不填
  funId: 'xxx', // 功能id
  funName: 'xxx', // 功能名称
}, () => {
  // 上报成功后的回调，可不填，同步执行
});

Enum

// 上报类型
enum CjmEventEnum {
  click_feature = 1, // 点击功能
  view_page = 2,     // 查看页面
  play_video = 3,    // 播放视频
}

// 用户来源
enum CjmUserSourceEnum {
  other = 0,  // 其他
  pc = 1,     // pc
  wechat = 2, // 微信
  zlb = 3,    // 浙里办
  app = 4,    // app
  h5 = 5,     // h5
}

LICENSE

MIT