# @flare-engine/errors 中文文档

规范地址：https://npmcn.com/package/%40flare-engine/errors/

版本：0\.4\.12
npm 元数据更新时间：2026-11-12T19:46:41.600Z
中文译文更新时间：2026-11-14T21:42:30.201Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：106 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- peer 依赖：react \>=19\.0\.0，@sentry/react-native \>=5\.0\.0
- 首次发布：2026-06-09T16:19:40.366Z
- 最新版本发布：2026-11-12T19:46:41.234Z
- 近 30 天下载量：2470（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

反应出出错边界、结构化崩溃有效载荷、可插接的崩溃运输

## 安装

```sh
npm install @flare-engine/errors
```

也可以使用：`pnpm add @flare-engine/errors`、`yarn add @flare-engine/errors`、`bun add @flare-engine/errors`

## README

# @flare-engine/误差

反应出出错边界+结构化相撞有效载荷. `createCrashPayload(err, context?)` 将任何抛出值常态化为稳定值 `CrashPayload` 形状。 可插件 `CrashTransport` 汇 : `createNoopTransport`, (中文(简体) ), `createConsoleTransport`, (中文(简体) ), `createSentryTransport` (懒惰装入) `@sentry/react-native`,可选的对等函数)和 `composeTransports` 为粉丝出.

## 安装

```sh
bun add @flare-engine/errors
```

可选的对等分页 : `react`, (中文(简体) ), `@sentry/react-native` (只有你给哨兵运输系统电线).

## 使用量

```tsx
import { ErrorBoundary, createSentryTransport, createConsoleTransport,
         composeTransports, type CrashPayload } from '@flare-engine/errors';
import type { ReactNode } from 'react';

declare function CrashScreen(props: { err: CrashPayload; onRetry: () => void }): ReactNode;
declare function App(): ReactNode;

const transport = composeTransports(
  createConsoleTransport(),
  createSentryTransport({ dsn: 'https://xxx@o0.ingest.sentry.io/0', enabled: true }),
);

<ErrorBoundary
  fallback={(err, reset) => <CrashScreen err={err} onRetry={reset} />}
  transport={transport}
  context={{ scene: 'play', level: 4 }}
>
  <App />
</ErrorBoundary>
```

`createSentryTransport` 启动 SDK 本身的捕获器关闭的哨兵——没有全局错误或 拒绝处理器,没有自动会话跟踪,没有本地崩溃处理,没有控制台/网络 仪器——因此,哨兵只发送所发送的运输物品,并装有同意检查 运输站的前面 整个过程的联署材料错误通过 `installGlobalErrorCapture` (下节. 一个例外是运输无法关闭:在Android 11+上 自行通过ANRs;如果同意必须涵盖这些内容,确定 `io.sentry.anr.enable` 元数据到 `false` 在你的Android清单中[哨兵和机器人文件](https://docs.sentry.io/platforms/android/configuration/app-not-respond/)) (中文(简体) ).

选择放弃融合是一种蓄意行为: `integrations` 钩子接收 允许列表( e)`kept`)和SDK自己的默认列表(`defaults`返回什么 `init` 用户。 每个 条目为 a `SentryIntegrationLike` (单位:千美元)`{ name }`因此没有 `@sentry/react-native` 需要类型.

```ts
import { createSentryTransport } from '@flare-engine/errors';

const transport = createSentryTransport({
  dsn: 'https://xxx@o0.ingest.sentry.io/0',
  integrations: (kept, defaults) => [
    ...kept,
    ...defaults.filter((integration) => integration.name === 'Breadcrumbs'),
  ],
});
```

正在返回 `defaults`,或通过任何捕获集成,例如 `ReactNativeErrorHandlers`,重新启用 哨兵本身的全球处理器,这些处理器在 运输,所以没有 任何同意检查 在它的前面。 扔出一钩被记录下来 使用许可列表.

在取消同意时,关闭运输。 哨兵运输在等待SDK的 `close()` 一次 (只有装过子弹),每晚 `report()` 无发送; 秒 `close()` 决定 不再关闭. `composeTransports` 转发 `close()` 给每个有孩子的孩子,所以 链条从第一个例子关闭在一个调用中:

```ts
import { composeTransports, createConsoleTransport, createSentryTransport } from '@flare-engine/errors';

const transport = composeTransports(
  createConsoleTransport(),
  createSentryTransport({ dsn: 'https://xxx@o0.ingest.sentry.io/0' }),
);

// later, when the user withdraws consent:
await transport.close?.();
```

`close` 可选于 `CrashTransport`· ; `createNoopTransport`, (中文(简体) ), `createConsoleTransport` 编辑 无 DSN 选项 `createSentryTransport` 返回时未定义.

## 抓住边界所不能达到的

`ErrorBoundary` 只在 React 渲染相中看到出错 。 游戏的坠机大多是 不在那里——他们处在更新的循环中,在资产负荷中,在没有人期待的许诺中. `installGlobalErrorCapture` 进入同一运输链的路线.

```ts
import { installGlobalErrorCapture, createConsoleTransport } from '@flare-engine/errors';

// `globalThis` supplies `addEventListener` on web and `ErrorUtils` on React
// Native, so one call covers both.
const capture = installGlobalErrorCapture(globalThis, {
  transport: createConsoleTransport(),
  context: { build: '1.2.3' },
});

// Later, e.g. on scene teardown or hot reload:
capture.uninstall();
```

运输工具可以附加 **之后** 安装。 二者之间出现的错误在小环中保存 缓冲器(默认为 20,最古老的掉落),并排入了接力上,所以在靴子时发生的相撞事件—— 通常有趣的——不会丢失,而您的记者仍在初始化:

```ts
import { installGlobalErrorCapture, createClientTransport } from '@flare-engine/errors';

declare const Sentry: { captureException(error: unknown, hint?: unknown): unknown };

const capture = installGlobalErrorCapture(globalThis);   // no transport yet
// ... boot, read config, initialise the reporter ...
capture.setTransport(createClientTransport(Sentry));     // buffered errors drain here
```

有两件事值得了解:

-   在上一个原生反应 `ErrorUtils` 处理器是 **连锁,没有替换** - 那个操作员是 显示开发中的红盒 并结束一个致命的过程, 所以它仍然运行. `uninstall()` 复还之.
-   `createSentryTransport` 纯本地( 它导入) `@sentry/react-native`) (中文(简体) ). `createClientTransport` 是 web 对应程序: 您打开浏览器客户端并注入它, 所以 此软件包取决于没有自己的记者.

见 [API 规格](https://github.com/grzott/flare-engine/blob/main/docs/design/api-specs.md#flare-engineerrors--2kb-raw)。 。 。 .

## 许可证

阿帕奇 - 2.0

## 常见问题

### @flare-engine/errors 是什么？

反应出出错边界、结构化崩溃有效载荷、可插接的崩溃运输

### 如何安装 @flare-engine/errors？

在项目目录运行 npm install @flare-engine/errors，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @flare-engine/errors 支持 TypeScript 吗？

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

### @flare-engine/errors 支持 ESM 还是 CommonJS？

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

### @flare-engine/errors 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @flare-engine/errors 可以商用吗？

@flare-engine/errors 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @flare-engine/errors 的下载量有多少？

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

### @flare-engine/errors 还在维护吗？

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