@ bugfender/ 电容器

远程记录、崩溃报告和应用程序中的用户反馈 臭虫师 财务报告和审定财务报表 电容。 。 。 .

此模块是自第4版起Capacitor的插件. 你用得着 @bugfender/capacitor 在iOS,Android,网络和电子平台的Ionic项目中.

安装

npm install @bugfender/capacitor @bugfender/sdk @bugfender/common
npx cap sync

使用量

像这样导入臭虫 :

import { Bugfender } from '@bugfender/capacitor';

说明: 总是导入 @bugfender/capacitor 改为 @bugfender/sdk。 。 。 . 这将使SDK的原生特征成为你无法得到的.

网络记录

网络记录为 选入 并默认禁用。 启用时, HTTP 请求会作为日志在 Bugfender 中显示 bf_network。 。 。 .

Bugfender.setNetworkLoggingEnabled(true);
// Optional:
Bugfender.setNetworkLoggingCaptureBodies(false);
Bugfender.setNetworkLoggingCaptureErrorResponseBodies(true);
Bugfender.setNetworkLoggingURLFilter(
  ['https://api.example.com/*'],
  ['*/secrets/*']
);
Bugfender.setNetworkLoggingMaxRequestsPerMinute(60);

// Optional: redact sensitive headers/bodies before they are logged
Bugfender.setNetworkLoggingRequestObfuscationHandler((url, headers, body) => ({
  url,
  headers: { ...headers, authorization: '[REDACTED]' },
  body,
}));
Bugfender.setNetworkLoggingResponseObfuscationHandler((headers, body) => ({
  headers,
  body: body ? body.replace(/"token":"[^"]*"/g, '"token":"[REDACTED]"') : null,
}));

您也可以启用它的时间与 networkLoggingEnabled, (中文(简体) ), networkLoggingCaptureBodies,以及 networkLoggingCaptureErrorResponseBodies。 。 。 .

平台注释:

• iOS: (英语) URL会话流量被捕获(在使用URL会话时包括电容HTTP). 需要臭虫 iOS SDK 3.0.1+ (单位:千美元)。 。 。 .
• 机器人: OkHttp的交通通过 android-okhttp 适配器. 需要臭虫Android SDK 4.x (中文(简体) ). 注:电容已内置 CapacitorHttp 用途 HttpURLConnection 和Android和现在 没有 已观察到; apps 应使用 OKHttp( 或示例) sendInstrumentedNetworkRequest 帮助)用于网络日志.
• 网络/ 电子 : 用途 @bugfender/sdk (≥ 4.0.0),拦截 fetch 财务报告和审定财务报表 XMLHttpRequest。 。 。 .

API 密码

请检查以下 URL 以获取完整的 API 引用 : https://js.bugfender.com (中文(简体) )。 。 。 .

• init(...)
• forceSendOnce()
• getDeviceURL()
• getSessionURL()
• getUserFeedback(...)
• log(...)
• log(...)
• warn(...)
• warn(...)
• error(...)
• error(...)
• trace(...)
• trace(...)
• info(...)
• info(...)
• fatal(...)
• fatal(...)
• removeDeviceKey(...)
• sendLog(...)
• sendIssue(...)
• sendCrash(...)
• sendUserFeedback(...)
• setDeviceKey(...)
• setForceEnabled(...)
• setSDKType(...)
• setNetworkLoggingEnabled(...)
• setNetworkLoggingCaptureBodies(...)
• setNetworkLoggingCaptureErrorResponseBodies(...)
• setNetworkLoggingRequestObfuscationHandler(...)
• setNetworkLoggingResponseObfuscationHandler(...)
• setNetworkLoggingURLFilter(...)
• setNetworkLoggingMaxRequestsPerMinute(...)
• 接口
• 类型异名
• 数字

因数(...)

init(options: SDKOptions) => Promise<void>

强制发送( C)

forceSendOnce() => void

获取DeviceurL ()

getDeviceURL() => Promise<string>

回返情况: Promise<string>

获取会议( )

getSessionURL() => Promise<string>

回返情况: Promise<string>

获取用户Feedback(...)

getUserFeedback(options?: UserFeedbackOptions | undefined) => Promise<UserFeedbackResult>

回返情况: Promise<UserFeedbackResult>

日志(...)

log(obj: unknown, ...objs: unknown[]) => void

日志(...)

log(msg: string, ...subst: unknown[]) => void

警告(...)

warn(obj: unknown, ...objs: unknown[]) => void

警告(...)

warn(msg: string, ...subst: unknown[]) => void

错误(...)

error(obj: unknown, ...objs: unknown[]) => void

错误(...)

error(msg: string, ...subst: unknown[]) => void

跟踪(...)

trace(obj: unknown, ...objs: unknown[]) => void

跟踪(...)

trace(msg: string, ...subst: unknown[]) => void

信息(...)

info(obj: unknown, ...objs: unknown[]) => void

信息(...)

info(msg: string, ...subst: unknown[]) => void

致命(...)

fatal(obj: unknown, ...objs: unknown[]) => void

致命(...)

fatal(msg: string, ...subst: unknown[]) => void

删除DeviceKey(...)

removeDeviceKey(key: string) => void

发送日志(...)

sendLog(log: LogEntry) => void

发送 Issue (...)

sendIssue(title: string, text: string) => Promise<string>

回返情况: Promise<string>

发送崩溃(...)

sendCrash(title: string, text: string) => Promise<string>

回返情况: Promise<string>

发送用户Feed back(...)

sendUserFeedback(title: string, text: string) => Promise<string>

回返情况: Promise<string>

设置DeviceKey(...)

setDeviceKey(key: string, value: DeviceKeyValue) => void

已生效(...)

setForceEnabled(state: boolean) => void

设置SDKType(...)

setSDKType(sdkType: string, version: number) => void

设置网络日志Enabled(...)

setNetworkLoggingEnabled(enabled: boolean) => void

启用或禁用网络记录( 默认: 假) .

设置网络记录

setNetworkLoggingCaptureBodies(capture: boolean) => void

全模式:抓取请求/应答机构(默认:假).

设置网络记录

setNetworkLoggingCaptureErrorResponseBodies(capture: boolean) => void

错误-只有正文模式:只为HTTP状态QQ 400(默认:假)捕获响应正文.

设置网络日志请求ObfuscationHandler(...)

setNetworkLoggingRequestObfuscationHandler(handler: ((url: string, headers: Record<string, string>, body: string | null) => { url: string; headers: Record<string, string>; body: string | null; }) | null) => void

请求混淆—— (url, headers, body) { url, headers, body}.

设置NetworkLogging ResponseObfuscationHandler(...)

setNetworkLoggingResponseObfuscationHandler(handler: ((headers: Record<string, string>, body: string | null) => { headers: Record<string, string>; body: string | null; }) | null) => void

反应歧义——(头,身) {{头,身}.

设置网络LoggingURLFilter(...)

setNetworkLoggingURLFilter(allowlist: string[] | null, denylist: string[] | null) => void

URL过滤:允许列表/拒绝列表. null = 无过滤器.

设置NetworkLoggingMax 请求 PerMinte (.)

setNetworkLoggingMaxRequestsPerMinute(count: number | null) => void

利率限制。 Null=无限制.

接口

SDK 选项

除外信息

用于确定是否应忽略的例外的信息

错误

正则Exp

Reg ExpExec 阵列

用户Fedback Result 成功

用户Feedback 结果取消

用户Feedback 选项

选项对象 Bugfender.getUserFeedback 带有自定义模式字符串.

日志条目

日志条目对象接口

类型异名

例外过滤器

忽略例外的配置 . 可能会是:

• 接收例外信息并返回布尔函数
• 一系列图案(字符串或 正则Exp与错误消息匹配
• 两者的结合(职能和模式)

ExceptionFilterFunction | ExceptionPattern[] | { /** Function to determine if exception should be ignored / filter?: ExceptionFilterFunction; /* Patterns to match against error message */ patterns?: ExceptionPattern[]; }

除外过滤功能

确定是否应当忽略例外的函数 . 返回时 true 无视例外, false 以报之.

(info: ExceptionInfo): boolean

例外软件

可以用来匹配例外消息的图案. 可以是字符串(精确或子字符串匹配)或 正则Exp。 。 。 .

string | RegExp

用户Feedback 结果

UserFeedbackResultSuccess | UserFeedbackResultCancel

设备KeyValue

string | number | boolean

记录

构造 T 类型 K 的一组属性类型

{ [P in K]: T; }

数字

日志级别