# @bugfender/capacitor 中文文档

规范地址：https://npmcn.com/package/%40bugfender/capacitor/

版本：5\.0\.0
npm 元数据更新时间：2026-07-27T11:27:08.840Z
中文译文更新时间：2026-11-08T19:52:12.785Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bugfender/capacitor
原文对照：https://npmcn.com/package/%40bugfender/capacitor/?lang=original
项目主页：https://github.com/bugfender/bugfender-capacitor#readme
源码仓库：https://github.com/bugfender/bugfender-capacitor

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：274 kB，38 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@bugfender/common ^2\.0\.0，@bugfender/sdk ^4\.0\.1，@capacitor/core ^8\.4\.2
- 首次发布：2022-08-15T09:28:13.596Z
- 最新版本发布：2026-07-27T11:27:08.633Z
- 近 30 天下载量：2700（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 2 个）

## 中文简介

用 Bugfender 远程记录

## 安装

```sh
npm install @bugfender/capacitor
```

也可以使用：`pnpm add @bugfender/capacitor`、`yarn add @bugfender/capacitor`、`bun add @bugfender/capacitor`

## README

# @ bugfender/ 电容器

远程记录、崩溃报告和应用程序中的用户反馈 [臭虫师](https://bugfender.com/) 财务报告和审定财务报表 [电容](https://capacitorjs.com/)。 。 。 .

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

## 安装

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

## 使用量

像这样导入臭虫 :

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

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

### 网络记录

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

```typescript
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 (中文(简体) )](https://js.bugfender.com/)。 。 。 .

-   [`init(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-init)
-   [`forceSendOnce()`](https://npmcn.com/package/%40bugfender/capacitor/#readme-forcesendonce)
-   [`getDeviceURL()`](https://npmcn.com/package/%40bugfender/capacitor/#readme-getdeviceurl)
-   [`getSessionURL()`](https://npmcn.com/package/%40bugfender/capacitor/#readme-getsessionurl)
-   [`getUserFeedback(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-getuserfeedback)
-   [`log(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-log)
-   [`log(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-log)
-   [`warn(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-warn)
-   [`warn(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-warn)
-   [`error(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-error)
-   [`error(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-error)
-   [`trace(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-trace)
-   [`trace(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-trace)
-   [`info(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-info)
-   [`info(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-info)
-   [`fatal(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-fatal)
-   [`fatal(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-fatal)
-   [`removeDeviceKey(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-removedevicekey)
-   [`sendLog(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-sendlog)
-   [`sendIssue(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-sendissue)
-   [`sendCrash(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-sendcrash)
-   [`sendUserFeedback(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-senduserfeedback)
-   [`setDeviceKey(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-setdevicekey)
-   [`setForceEnabled(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-setforceenabled)
-   [`setSDKType(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-setsdktype)
-   [`setNetworkLoggingEnabled(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-setnetworkloggingenabled)
-   [`setNetworkLoggingCaptureBodies(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-setnetworkloggingcapturebodies)
-   [`setNetworkLoggingCaptureErrorResponseBodies(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-setnetworkloggingcaptureerrorresponsebodies)
-   [`setNetworkLoggingRequestObfuscationHandler(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-setnetworkloggingrequestobfuscationhandler)
-   [`setNetworkLoggingResponseObfuscationHandler(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-setnetworkloggingresponseobfuscationhandler)
-   [`setNetworkLoggingURLFilter(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-setnetworkloggingurlfilter)
-   [`setNetworkLoggingMaxRequestsPerMinute(...)`](https://npmcn.com/package/%40bugfender/capacitor/#readme-setnetworkloggingmaxrequestsperminute)
-   [接口](https://npmcn.com/package/%40bugfender/capacitor/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40bugfender/capacitor/#readme-type-aliases)
-   [数字](https://npmcn.com/package/%40bugfender/capacitor/#readme-enums)

### 因数(...)

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

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[SDKOptions](https://npmcn.com/package/%40bugfender/capacitor/#readme-sdkoptions)` |

* * *

### 强制发送( C)

```typescript
forceSendOnce() => void
```

* * *

### 获取DeviceurL ()

```typescript
getDeviceURL() => Promise<string>
```

**回返情况:** `Promise<string>`

* * *

### 获取会议( )

```typescript
getSessionURL() => Promise<string>
```

**回返情况:** `Promise<string>`

* * *

### 获取用户Feedback(...)

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

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[UserFeedbackOptions](https://npmcn.com/package/%40bugfender/capacitor/#readme-userfeedbackoptions)` |

**回返情况:** `Promise<[UserFeedbackResult](https://npmcn.com/package/%40bugfender/capacitor/#readme-userfeedbackresult)>`

* * *

### 日志(...)

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

| 参数 | 类型 |
| --- | --- |
| **`obj`** | `unknown` |
| **`objs`** | `unknown[]` |

* * *

### 日志(...)

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

| 参数 | 类型 |
| --- | --- |
| **`msg`** | `string` |
| **`subst`** | `unknown[]` |

* * *

### 警告(...)

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

| 参数 | 类型 |
| --- | --- |
| **`obj`** | `unknown` |
| **`objs`** | `unknown[]` |

* * *

### 警告(...)

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

| 参数 | 类型 |
| --- | --- |
| **`msg`** | `string` |
| **`subst`** | `unknown[]` |

* * *

### 错误(...)

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

| 参数 | 类型 |
| --- | --- |
| **`obj`** | `unknown` |
| **`objs`** | `unknown[]` |

* * *

### 错误(...)

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

| 参数 | 类型 |
| --- | --- |
| **`msg`** | `string` |
| **`subst`** | `unknown[]` |

* * *

### 跟踪(...)

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

| 参数 | 类型 |
| --- | --- |
| **`obj`** | `unknown` |
| **`objs`** | `unknown[]` |

* * *

### 跟踪(...)

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

| 参数 | 类型 |
| --- | --- |
| **`msg`** | `string` |
| **`subst`** | `unknown[]` |

* * *

### 信息(...)

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

| 参数 | 类型 |
| --- | --- |
| **`obj`** | `unknown` |
| **`objs`** | `unknown[]` |

* * *

### 信息(...)

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

| 参数 | 类型 |
| --- | --- |
| **`msg`** | `string` |
| **`subst`** | `unknown[]` |

* * *

### 致命(...)

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

| 参数 | 类型 |
| --- | --- |
| **`obj`** | `unknown` |
| **`objs`** | `unknown[]` |

* * *

### 致命(...)

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

| 参数 | 类型 |
| --- | --- |
| **`msg`** | `string` |
| **`subst`** | `unknown[]` |

* * *

### 删除DeviceKey(...)

```typescript
removeDeviceKey(key: string) => void
```

| 参数 | 类型 |
| --- | --- |
| **`key`** | `string` |

* * *

### 发送日志(...)

```typescript
sendLog(log: LogEntry) => void
```

| 参数 | 类型 |
| --- | --- |
| **`log`** | `[LogEntry](https://npmcn.com/package/%40bugfender/capacitor/#readme-logentry)` |

* * *

### 发送 Issue (...)

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

| 参数 | 类型 |
| --- | --- |
| **`title`** | `string` |
| **`text`** | `string` |

**回返情况:** `Promise<string>`

* * *

### 发送崩溃(...)

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

| 参数 | 类型 |
| --- | --- |
| **`title`** | `string` |
| **`text`** | `string` |

**回返情况:** `Promise<string>`

* * *

### 发送用户Feed back(...)

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

| 参数 | 类型 |
| --- | --- |
| **`title`** | `string` |
| **`text`** | `string` |

**回返情况:** `Promise<string>`

* * *

### 设置DeviceKey(...)

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

| 参数 | 类型 |
| --- | --- |
| **`key`** | `string` |
| **`value`** | `[DeviceKeyValue](https://npmcn.com/package/%40bugfender/capacitor/#readme-devicekeyvalue)` |

* * *

### 已生效(...)

```typescript
setForceEnabled(state: boolean) => void
```

| 参数 | 类型 |
| --- | --- |
| **`state`** | `boolean` |

* * *

### 设置SDKType(...)

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

| 参数 | 类型 |
| --- | --- |
| **`sdkType`** | `string` |
| **`version`** | `number` |

* * *

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

```typescript
setNetworkLoggingEnabled(enabled: boolean) => void
```

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

| 参数 | 类型 |
| --- | --- |
| **`enabled`** | `boolean` |

* * *

### 设置网络记录

```typescript
setNetworkLoggingCaptureBodies(capture: boolean) => void
```

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

| 参数 | 类型 |
| --- | --- |
| **`capture`** | `boolean` |

* * *

### 设置网络记录

```typescript
setNetworkLoggingCaptureErrorResponseBodies(capture: boolean) => void
```

[错误](https://npmcn.com/package/%40bugfender/capacitor/#readme-error)\-只有正文模式:只为HTTP状态QQ 400(默认:假)捕获响应正文.

| 参数 | 类型 |
| --- | --- |
| **`capture`** | `boolean` |

* * *

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

```typescript
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}.

| 参数 | 类型 |
| --- | --- |
| **`handler`** | `((url: string, headers: [Record](https://npmcn.com/package/%40bugfender/capacitor/#readme-record)<string, string>, body: string | null) => { url: string; headers: [Record](https://npmcn.com/package/%40bugfender/capacitor/#readme-record)<string, string>; body: string | null; }) | null` |

* * *

### 设置NetworkLogging ResponseObfuscationHandler(...)

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

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

| 参数 | 类型 |
| --- | --- |
| **`handler`** | `((headers: [Record](https://npmcn.com/package/%40bugfender/capacitor/#readme-record)<string, string>, body: string | null) => { headers: [Record](https://npmcn.com/package/%40bugfender/capacitor/#readme-record)<string, string>; body: string | null; }) | null` |

* * *

### 设置网络LoggingURLFilter(...)

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

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

| 参数 | 类型 |
| --- | --- |
| **`allowlist`** | `string[] | null` |
| **`denylist`** | `string[] | null` |

* * *

### 设置NetworkLoggingMax 请求 PerMinte (.)

```typescript
setNetworkLoggingMaxRequestsPerMinute(count: number | null) => void
```

利率限制。 Null=无限制.

| 参数 | 类型 |
| --- | --- |
| **`count`** | `number | null` |

* * *

### 接口

#### SDK 选项

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`appKey`** | `string` | 登录的应用密钥 |
| **`apiURL`** | `string` | 基准 URL 到 Bugfender API |
| **`build`** | `string` | 应用程序构建标识符 |
| **`baseURL`** | `string` | 基准 URL 到 Bugfender 网络仪表板 |
| **`debug`** | `boolean` | 将 SDK 设置为调试模式 |
| **`deviceName`** | `string` | 设备名称, 这将显示在仪表盘设备列表中 。 默认为浏览器 + OS . |
| **`overrideConsoleMethods`** | `boolean` | 覆盖默认 `window.console` 因此,它也登录到 Bugfender。 默认为 `true`。 。 。 . |
| **`printToConsole`** | `boolean` | 打印也带有 `window.console` 当调用 Bugfender 记录方法时。 默认为 `true`。 。 。 . |
| **`logBrowserEvents`** | `boolean` | 注册最常见浏览器事件的处理器,向 Bugfender 报告. 默认为 `true`。 。 。 . |
| **`logUIEvents`** | `boolean` | 注册一个处理器来处理最常见的 UI 事件, 向 Bugfender 报告 。 默认为 `true`。 。 。 . |
| **`registerErrorHandler`** | `boolean` | 注册未发现错误处理器, 向 Bugfender 报告崩溃 。 默认为 `true`。 。 。 . |
| **`ignoreException`** | `[ExceptionFilter](https://npmcn.com/package/%40bugfender/capacitor/#readme-exceptionfilter)` | 配置例外过滤器, 以忽略某些被报告为崩溃的例外 。 - 函数: `(info) =&gt; info.message.includes('Script error')` - 一系列图案: `['Script error', /^ResizeObserver/i]` - 两者兼有的物体: `{ filter: (info) =&gt; ..., patterns: [...] }` |
| **`version`** | `string` | App 版本标识符 |
| **`networkLoggingEnabled`** | `boolean` | 启用网络请求/ 响应抓取 。 默认为 `false`。 。 。 . **网络/联合系统**: 使用前需要输入. |
| **`networkLoggingCaptureBodies`** | `boolean` | 当启用网络记录时,捕获请求/响应机构(完整模式). 默认为 `false`。 。 。 . |
| **`networkLoggingCaptureErrorResponseBodies`** | `boolean` | 仅抓取HTTP状态QQ 400的出错反应机构(不抓取完整身体). 默认为 `false`。 。 。 . |
| **`maximumLocalStorageSize`** | `number` | 设定最大大小以字节存储本地日志文件 。 接受的范围为1MB至50MB. 默认为5MB. **仅使用 iOS & Android**。 。 。 . |
| **`enableLogcatLogging`** | `boolean` | 通过 Logcat 记录所有日志 。 默认为 `false`。 。 。 . **只有机器人**。 。 。 . |

#### 除外信息

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

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`message`** | `string` | 错误消息 |
| **`error`** | `[Error](https://npmcn.com/package/%40bugfender/capacitor/#readme-error)` | 错误对象( 如果可用) |
| **`stack`** | `string` | 堆栈追踪, 如果有的话 |
| **`filename`** | `string` | 错误发生地的文件名/ URL |
| **`line`** | `number` | 错误发生地的行号 |
| **`handler`** | `string` | 发生错误的处理器类型( 例如 )[错误](https://npmcn.com/package/%40bugfender/capacitor/#readme-error)',"无所取回" |

#### 错误

| Prop | 类型 |
| --- | --- |
| **`name`** | `string` |
| **`message`** | `string` |
| **`stack`** | `string` |

#### 正则Exp

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`source`** | `string` | 返回正则表达式模式的文本副本。 唯相读取. regExp 参数是一个正则表达式对象. 可以是可变名或字形. |
| **`global`** | `boolean` | 返回一个布尔值,表示带有正则表达式的全球旗帜(g)的状态。 默认是虚假的。 唯相读取. |
| **`ignoreCase`** | `boolean` | 返回一个布尔值,表示带有正则表达式的被忽略的Case旗(一)的状态。 默认是虚假的。 唯相读取. |
| **`multiline`** | `boolean` | 返回一个布尔值,表示使用正则表达式的多行旗 (m) 状态。 默认是虚假的。 唯相读取. |
| **`lastIndex`** | `number` |  |

| 方法 | 签署 | 说明 |
| --- | --- | --- |
| **执行** | (字符串:字符串) [Reg ExpExec 阵列](https://npmcn.com/package/%40bugfender/capacitor/#readme-regexpexecarray) 无效 | 使用正则表达式模式执行对字符串的搜索,并返回包含搜索结果的数组. |
| **测试** | (字符串:字符串) | 返回一个布尔值,表示搜索字符串中是否存在一个图案. |
| **编译** | (这个) |  |

#### Reg ExpExec 阵列

| Prop | 类型 |
| --- | --- |
| **`index`** | `number` |
| **`input`** | `string` |

#### 用户Fedback Result 成功

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`isSent`** | `true` | 用户已发送反馈. |
| **`feedbackURL`** | `string` | 反馈的臭虫 URL . |

#### 用户Feedback 结果取消

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`isSent`** | `false` | 用户已关闭模式而不发送 . |

#### 用户Feedback 选项

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

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`title`** | `string` | 默认 : `Feedback`。 。 。 . |
| **`hint`** | `string` | 默认 : `Please insert your feedback here and click send`。 。 。 . |
| **`subjectPlaceholder`** | `string` | 默认 : `Subject…`。 。 。 . |
| **`feedbackPlaceholder`** | `string` | 默认 : `Your feedback…`。 。 。 . |
| **`submitLabel`** | `string` | 默认 : `Send`。 。 。 . |
| **`closeLabel`** | `string` | 默认 : `Close`。 。 。 . **仅iOS**。 。 。 . |

#### 日志条目

日志条目对象接口

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`line`** | `number` | 触发日志的行号 |
| **`level`** | `[LogLevel](https://npmcn.com/package/%40bugfender/capacitor/#readme-loglevel)` | 基于 [日志级别](https://npmcn.com/package/%40bugfender/capacitor/#readme-loglevel) 常数 |
| **`tag`** | `string` | 日志的标签 |
| **`method`** | `string` | 触发日志的方法名称 |
| **`file`** | `string` | 日志所触发的文件名 |
| **`text`** | `string | unknown[]` | 文字可以是: - `string` 内容 `unknown[]` 符合 `console.*` 签名 |
| **`url`** | `string` | 日志的来源 URL. Android & iOS 上忽略了这个属性 |

### 类型异名

#### 例外过滤器

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

-   接收例外信息并返回布尔函数
-   一系列图案(字符串或 [正则Exp](https://npmcn.com/package/%40bugfender/capacitor/#readme-regexp)与错误消息匹配
-   两者的结合(职能和模式)

`[ExceptionFilterFunction](https://npmcn.com/package/%40bugfender/capacitor/#readme-exceptionfilterfunction) | ExceptionPattern[] | { /** Function to determine if exception should be ignored _/ filter?: [ExceptionFilterFunction](https://npmcn.com/package/%40bugfender/capacitor/#readme-exceptionfilterfunction); /_* Patterns to match against error message */ patterns?: ExceptionPattern[]; }`

#### 除外过滤功能

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

`(info: [ExceptionInfo](https://npmcn.com/package/%40bugfender/capacitor/#readme-exceptioninfo)): boolean`

#### 例外软件

可以用来匹配例外消息的图案. 可以是字符串(精确或子字符串匹配)或 [正则Exp](https://npmcn.com/package/%40bugfender/capacitor/#readme-regexp)。 。 。 .

`string | [RegExp](https://npmcn.com/package/%40bugfender/capacitor/#readme-regexp)`

#### 用户Feedback 结果

`[UserFeedbackResultSuccess](https://npmcn.com/package/%40bugfender/capacitor/#readme-userfeedbackresultsuccess) | [UserFeedbackResultCancel](https://npmcn.com/package/%40bugfender/capacitor/#readme-userfeedbackresultcancel)`

#### 设备KeyValue

`string | number | boolean`

#### 记录

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

`{ [P in K]: T; }`

### 数字

#### 日志级别

| 成员 | 数值 |
| --- | --- |
| **`Debug`** | `0` |
| **`Warning`** | `1` |
| **`Error`** | `2` |
| **`Trace`** | `3` |
| **`Info`** | `4` |
| **`Fatal`** | `5` |

## 常见问题

### @bugfender/capacitor 是什么？

用 Bugfender 远程记录

### 如何安装 @bugfender/capacitor？

在项目目录运行 npm install @bugfender/capacitor，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@bugfender/common（^2\.0\.0）、@bugfender/sdk（^4\.0\.1）、@capacitor/core（^8\.4\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bugfender/capacitor 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @bugfender/capacitor 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @bugfender/capacitor 可以商用吗？

@bugfender/capacitor 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @bugfender/capacitor 的下载量有多少？

根据 npm 官方下载统计，@bugfender/capacitor 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,700 次，日均约 90 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bugfender/capacitor 还在维护吗？

最新版本 5\.0\.0 发布于 2026/07/27（3 个月前）；至今共发布 14 个版本，其中过去 12 个月发布了 2 个；首次发布于 2022/08/15。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。