# @eggjs/onerror 中文文档

规范地址：https://npmcn.com/package/%40eggjs/onerror/

版本：4\.1\.0
npm 元数据更新时间：2026-10-07T08:20:04.230Z
中文译文更新时间：2026-11-13T10:00:00.260Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40eggjs/onerror
原文对照：https://npmcn.com/package/%40eggjs/onerror/?lang=original
项目主页：https://github.com/eggjs/egg/tree/next/plugins/onerror
源码仓库：https://github.com/eggjs/egg

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

- 包体积（解压后）：125 kB，21 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：3 个
- peer 依赖：egg 4\.2\.0
- 首次发布：2025-02-02T15:51:45.615Z
- 最新版本发布：2026-10-07T08:20:03.861Z
- 近 30 天下载量：4817（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：58（近 12 个月 33 个）

## 中文简介

蛋类处理器出错

## 安装

```sh
npm install @eggjs/onerror
```

也可以使用：`pnpm add @eggjs/onerror`、`yarn add @eggjs/onerror`、`bun add @eggjs/onerror`

## README

# @eggjs/ 错误

[![NPM version](https://img.shields.io/npm/v/@eggjs/onerror.svg?style=flat-square)](https://npmjs.org/package/@eggjs/onerror) [![Known Vulnerabilities](https://snyk.io/test/npm/@eggjs/onerror/badge.svg?style=flat-square)](https://snyk.io/test/npm/@eggjs/onerror) [![npm download](https://img.shields.io/npm/dm/@eggjs/onerror.svg?style=flat-square)](https://npmjs.org/package/@eggjs/onerror) [![Node.js Version](https://img.shields.io/node/v/@eggjs/onerror.svg?style=flat)](https://nodejs.org/en/download/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com/) ![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eggjs/onerror)

彩蛋默认错误处理插件 .

## 使用量

`onerror` 插件默认在 egg 中启用 。 但你仍然可以配置它的属性来适应你的情景.

-   `errorPageUrl: String or Function` - 如果用户请求生产环境中的html页面并发生出乎意料的出错,它将重新引导用户到 `errorPageUrl`。 。 。 .
-   `accepts: Function` - 检测用户的请求是否接受 `json` 或者说 `html`。 。 。 .
-   `all: Function` - 定制错误处理器,如果 `all` 现在,谈判将被忽略.
-   `html: Function` - 自定义 html 错误处理器.
-   `text: Function` - 定制文本错误处理器.
-   `json: Function` - 定制 json 错误处理器.
-   `js: Function` - 定制 JSONP 错误处理器 .

```ts
// config/config.default.ts
import { defineConfig } from 'egg';

export default defineConfig({
  onerror: {
    // errorPageUrl support function
    errorPageUrl: (err, ctx) => ctx.errorPageUrl || '/500',
  },
});

// an accept detect function that mark all request with `x-requested-with=XMLHttpRequest` header accepts json.
function accepts(ctx) {
  if (ctx.get('x-requested-with') === 'XMLHttpRequest') return 'json';
  return 'html';
}
```

## 问题和建议

请打开一个问题 [这里](https://github.com/eggjs/egg/issues)。 。 。 .

## 许可证

[麻省理工学院](https://npmcn.com/package/%40eggjs/onerror/LICENSE)

## 贡献者

[![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors)

制造的 [贡献者-img](https://contrib.rocks/)。 。 。 .

## 常见问题

### @eggjs/onerror 是什么？

蛋类处理器出错

### 如何安装 @eggjs/onerror？

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

### @eggjs/onerror 支持 TypeScript 吗？

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

### @eggjs/onerror 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @eggjs/onerror 需要什么版本的 Node\.js？

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

### @eggjs/onerror 可以商用吗？

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

### @eggjs/onerror 的下载量有多少？

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

### @eggjs/onerror 还在维护吗？

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