# @atlaskit/report-error 中文文档

规范地址：https://npmcn.com/package/%40atlaskit/report-error/

版本：1\.0\.0
npm 元数据更新时间：2026-06-16T05:40:23.551Z
中文译文更新时间：2026-11-07T03:07:59.111Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40atlaskit/report-error
原文对照：https://npmcn.com/package/%40atlaskit/report-error/?lang=original
项目主页：https://bitbucket.org/atlassian/atlassian-frontend-monorepo#readme
源码仓库：https://bitbucket.org/atlassian/atlassian-frontend-monorepo

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

- 包体积（解压后）：4.7 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react ^18\.2\.0
- 首次发布：2025-02-21T06:48:51.949Z
- 最新版本发布：2026-06-16T05:40:23.423Z
- 近 30 天下载量：13258（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 1 个）

## 中文简介

平台错误报告器

## 安装

```sh
npm install @atlaskit/report-error
```

也可以使用：`pnpm add @atlaskit/report-error`、`yarn add @atlaskit/report-error`、`bun add @atlaskit/report-error`

## README

# 平台错误报告器

平台出错总线可以被平台组件用来向产品报告出错.

## 平台使用情况

```js
import { reportError } from '@atlaskit/report-error';

reportError({
    error: Error; // Error
    errorInfo: ErrorInfo; // ErrorInfo from 'react', available within ErrorBoundary
    interractionId?: string; // UFO interractionId, if available
})
```

## 产品使用情况

```js
// product root file
import { installErrorHandler } from '@atlaskit/report-error';

installErrorHandler(({
    error: Error; // Error
    errorInfo: ErrorInfo; // ErrorInfo from 'react', available within ErrorBoundary
    interactionId?: string; // UFO interractionId, if available
}) => {
    // log error to splunk

    // log error to sentry

    // any other custom error logging...
});
```

## 常见问题

### @atlaskit/report-error 是什么？

平台错误报告器

### 如何安装 @atlaskit/report-error？

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

### @atlaskit/report-error 支持 TypeScript 吗？

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

### @atlaskit/report-error 支持 ESM 还是 CommonJS？

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

### @atlaskit/report-error 可以商用吗？

@atlaskit/report-error 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @atlaskit/report-error 的下载量有多少？

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

### @atlaskit/report-error 还在维护吗？

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

