<!--
 * @Author: quanjie
 * @Date: 2022-10-25 14:42:46
 * @LastEditTime: 2022-10-26 10:39:33
 * @LastEditors: quanjie
 * @Description: 
 * @FilePath: /quanjiecc_sdk_ts/README.md
 * 可以输入预定的版权声明、个性签名、空行等
-->
# tracker

这是一个埋点SDK(This is a buried SDK)

使用方法如下(The usage is as follows)


```js
//初始化
import Tracker from 'quanjiecc_sdk_ts'

const track = new tracker({
            requestUrl:"xxx",
            historyTracker:true,
        });

```
options 介绍
Options introduction
```ts

/**
 * @requestUrl 接口地址
 * @historyTracker history上报
 * @hashTracker hash上报
 * @domTracker 携带Tracker-key 点击事件上报
 * @historyTracker sdkVersion sdk版本
 * @historyTracker extra 透传字段
 * @jsError js 和 promise 报错异常上报
 */
export interface DefaultOptons {
    user_id: number | string | undefined,,
    requestUrl: string | undefined,
    historyTracker: boolean,
    hashTracker: boolean,
    domTracker: boolean,
    sdkVersion: string | number,
    extra: Record<string, any> | undefined,
    jsError:boolean
}
```
上报数据结构
data struct
```ts
export interface SDK{
    event:			string,    			// 事件名称/event_name
	session_id:		string | number, 	// session id
	user_id:		number,      		// 用户id/user_id
	distinct_id:	string,    			// 匿名id/distinct_id
	create_time:	number ,				// 时间产生时间 / time
	property?:		{[key:string]:any},    // 事件属性 / event property
}
```


用法
usage
```js
const track = new tracker({
            requestUrl:"上报数据的url/http://xxxx",
            historyTracker:true,
        });
//添加用户id
tr.setUserId(user_id)

//自定义上报 必须要有 event 和 targetKey  两个字段
track.track("事件名称/event_name",{属性键:属性值,property_key:"property_value"})
```

# 发布流程
npm adduser

 WWyichuan

npm login

npm publish