# wby-tracker

> 一个前端js埋点SDK

Latest version **1.0.4** (published 2023-03-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install wby-tracker
pnpm add wby-tracker
yarn add wby-tracker
bun add wby-tracker
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2023-03-23 |
| First published | 2023-03-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 18.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | wby |
| Maintainers | wengbiyun |
| Keywords | 前端, 埋点, tracker |

## Links

- npm: https://www.npmjs.com/package/wby-tracker
- npm.io page: https://npm.io/package/wby-tracker

## Recent versions

- 1.0.4 (latest) — 2023-03-23
- 1.0.3 — 2023-03-23
- 1.0.2 — 2023-03-22
- 1.0.1 — 2023-03-22
- 1.0.0 — 2023-03-21

## README

### 简介
wby-tracker是一个前端js埋点SDK,用于数据采集-数据处理-数据分析和挖掘。

### 定义
js埋点是通过web页面中嵌入一段js脚本，监控用户在应用表现层的行为，使用户在访问页面时、自动触发js，收集用户访问行为日志，并提交到日志服务器。

### 统计指标
- PV（用户浏览量）=> MPA、SPA(history/hash)
- UV（独立访客数）=> 设置userId
- DOM（事件监听）=> 添加属性target-key
- error（js错误）
- promise（捕获错误）

### install
```javascript
npm install wby-tracker
```

### usage
```javascript
import Tracker from 'wby-tracker'

const tr = new Tracker({
    requestUrl:"xxxxxx", // 接口地址 必传
    loadTracker: true, // 多页面pv上报
    historyTracker: false, // history模式
    hashTracker: false, // hash模式
    domTracker: true, // dom操作
    jsError: true // error、promise错误捕获
})

// DOM上报 设置target-key 自动上报
<button target-key="埋点值">按钮</button>

// 添加用户id
tr.setUserId()

// 设置用户自定义参数
tr.setExtra()

// 自定义上报及参数
/**
 * @event 事件类型
 * @targetKey 事件标识
 * @data 上报数据 非必传
 */
tr.sendTracker({event:"事件类型",targetKey:"事件标识",data:{}})
```

### options
```javascript
/**
 * @userId 用户id uv标识
 * @requestUrl 接口上报地址
 * @loadTracker 多页面pv上报
 * @historyTracker history上报
 * @hashTracker hash上报
 * @domTracker 携带Tracker-key 事件上报
 * @sdkVersionsdk 版本
 * @extra 透传字段
 * @jsError js 和 promise 报错异常上报
 */
// 默认参数
export interface DefaultOptons {
  userId: string | undefined,
  requestUrl: string | undefined,
  loadTracker: boolean,
  historyTracker: boolean,
  hashTracker: boolean,
  domTracker: boolean,
  sdkVersion: string | number,
  extra: Record<string, any> | undefined,
  jsError:boolean
}
```

---
_Source: https://npm.io/package/wby-tracker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._