1.0.0-beta6 • Published 1 year ago

shu-dong-js-error v1.0.0-beta6

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

使用

demo

import { getEventError, getError, getAppEnv } from 'shu-dong-js-error'
/**
 * getEventError && getAppEnv
 * @param env 打包环境 为 production 时才推送日志
 * @param url 推送日志的地址
 * @param environment 当前环境 1 pc 2小程序
 */
// 挂载全局监听报错自动收集错误日志 main.js
getEventError(import.meta.env.VITE_APP_ENV,'https://xxx',1)

// 若不开启全局监听则需在main.js 中手动调用一次 getAppEnv
getAppEnv(import.meta.env.VITE_APP_ENV,'https://xxx',1)

// 主动捕获的error 可调用 getError
/**
 * getError
 * @param message 上报日志信息
 * @param param     请求额外附带信息
 * @param bizType   错误类型 从3开始 1为被动捕获,2为默认主动捕获
 *
 * @param param 内部属性如下 :
 *    @param url 上报文件地址
 *    @param line 上报行数
 *    @param params 上报额外信息
 *    @param error  上报时捕获的error
 */
getError(
    '赋值报错',
    {
        url: 'main.js',
        line: 35,
        params: '此处有可能出错',
        error,
    },
    3
)

注意事项

  1. getEventError 会默认调用 getAppEnv,所以如果在web端开启的全局捕获时无需调用 getAppEnv
  2. 如果只采用 getError 自定义上报错误日志时需在全局默认调用一次 getAppEnv 设置当前的开发环境,请求日志的接口地址,以及当前项目environment