# cl-tracker

> 一个埋点 SDK

Latest version **1.0.2** (published 2022-08-03) · ISC license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-08-03 |
| First published | 2022-08-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | qisan |
| Keywords | 前端, 埋点, tracker |

## Links

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

## Recent versions

- 1.0.2 (latest) — 2022-08-03
- 1.0.1 — 2022-08-03
- 1.0.0 — 2022-08-03

## README

一个埋点 SDK

使用方法如下

```html
<button onclick="handler()" tracker-key="btn">有埋点点击事件</button>
```

```js
import Tracker from "cl-tracker";

const tr = new Tracker({
  requestUrl: "xxx",
  historyTracker: true,
  hashTracker: true,
  domTracker: true,
  jsError: true,
});
```

可配置参数介绍

```ts
/**
 * @requestUrl 接口地址
 * @historyTracker history上报
 * @hashTracker hash上报
 * @domTracker 携带tracker-key 点击事件上报
 * @sdkVersion sdkVersion sdk版本
 * @historyTracker extra 透传字段
 * @jsError js 和 promise 报错异常上报
 */
export interface DefaultOptons {
  uuid: string | undefined;
  requestUrl: string | undefined;
  historyTracker: boolean;
  hashTracker: boolean;
  domTracker: boolean;
  sdkVersion: string | number;
  extra: Record<string, any> | undefined;
  jsError: boolean;
}
```

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