Skip to content

Commit

Permalink
chore: exportmethods方法确定
Browse files Browse the repository at this point in the history
  • Loading branch information
M-cheng-web committed May 8, 2023
1 parent 8e5d877 commit 148f620
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 22 deletions.
2 changes: 1 addition & 1 deletion examples/vanilla/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ function start() {
cacheMaxLength: 10,
cacheWatingTime: 1000,

scopeError: true,
// scopeError: true,

// tracesSampleRate: 0.5,

Expand Down
19 changes: 8 additions & 11 deletions packages/core/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@ import { initPerformance } from './src/lib/performance'
import { initPv } from './src/lib/pv'
import { _global } from './src/utils/global'

// 暴露给外部的方法
const exportMethods: ExportMethods = {
// setCustomerId: base.setCustomerId, // 舍弃
// setUserUuid: base.setUserUuid, // 舍弃
// traceError: err.traceError,
// tracePerformance: performance.tracePerformance,
// traceCustomEvent: event.traceCustomEvent,
Expand All @@ -36,15 +33,15 @@ const exportMethods: ExportMethods = {
beforeSendData: () => {
// do something
},
// 设置用户id,与sdk的用户id绑定
setUserId: () => {
// 钩子:发送之后
afterSendData: () => {
// do something
},
// 获取当前行为列表
getBreadcrumb: () => {
// 设置用户id,与sdk的用户id绑定
setUserUuid: () => {
// do something
},
getUserId: () => '', // 获取用户id(此id是初始化传入的id)
getUserUuid: () => '', // 获取用户id(此id是初始化传入的id)
getUserSDKId: () => '', // 获取用户此时在sdk中的id
handleDelayInit: () => {
// do something
Expand All @@ -61,15 +58,15 @@ const exportMethods: ExportMethods = {
trackScopeEnd: () => {
// do something
},
// 主动触发一条error类型事件
// 主动触发error类型事件
traceError: () => {
// do something
},
// 主动触发性能事件上报
// 主动触发资源性能事件上报
tracePerformance: () => {
// do something
},
// 主动触发事件上报
// 主动触发手动事件上报
traceCustomEvent: () => {
// do something
},
Expand Down
20 changes: 10 additions & 10 deletions packages/core/src/types/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,21 +134,21 @@ export type InitOptions = {
export type ExportMethods = {
beforePushEventList: (data: any) => any // 添加到行为列表前的 hook (在这里面可以给出错误类型,然后就能达到用户想拿到是何种事件类型的触发)
beforeSendData: (data: any) => any // 数据上报前的 hook
afterSendData?: (data: any) => void // 数据上报后的 hook
afterSendData: (data: any) => void // 数据上报后的 hook

setUserId: () => void // // 设置用户id,与sdk的用户id绑定
getBreadcrumb: () => any // 获取当前行为列表
getUserId: () => string // 获取用户id(此id是初始化传入的id)
getUserSDKId: () => string // 获取用户此时在sdk中的id
handleDelayInit: () => void // 设置延迟加载后这边手动初始化
getRouteTreeing: () => string[] // 获取路由历史记录 (前提是开启了监听路由)
getBaseInfo: () => any // 获取在sdk中记录的所有基础的信息 (包括硬件,地理位置等等)
setUserUuid: () => void // 设置用户id,与sdk的用户id绑定
getUserUuid: () => string // 获取用户id,此id为初始传入的id,sdk内部不会更改
getUserSDKId: () => string // 获取用户此时在sdk中的id,sdk会对每个用户提供一个“唯一”的id(尽量往唯一的方向靠,会参考多个参数)
getBaseInfo: () => any // 获取在sdk中记录的所有基础的信息(包括硬件,地理位置等等)
handleDelayInit: () => void // 手动初始化(设置延迟加载后才可以使用此方法手动初始化)
getRouteTreeing: () => string[] // 获取路由历史记录(前提是开启了监听路由)
getFirstScreen: () => any // 获取首屏数据

trackScopeStart: () => void // 开始范围捕捉事件(在这个范围中发生的所有事件都会集中到此范围中)
trackScopeEnd: () => void // 停止范围捕捉事件(后续可以加入一系列参数,回调等。让用户可选择的更多)
traceError: () => void // 主动触发一条error类型事件
tracePerformance: () => void // 主动触发性能事件上报

traceError: () => void // 主动触发error事件
tracePerformance: () => void // 主动触发资源上报
traceCustomEvent: () => void // 主动触发事件上报
tracePageView: () => void // 主动触发一条pv事件
}
Expand Down

0 comments on commit 148f620

Please sign in to comment.