# @eggjs/errors 中文文档

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

版本：3\.1\.0
npm 元数据更新时间：2026-10-07T08:19:06.366Z
中文译文更新时间：2026-11-13T11:42:02.511Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：50.1 kB，108 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>= 22\.18\.0
- 运行依赖：0 个
- 首次发布：2025-10-07T16:28:19.121Z
- 最新版本发布：2026-10-07T08:19:05.979Z
- 近 30 天下载量：4178（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：45（近 12 个月 36 个）

## 中文简介

@eggjs/errors提供两种错误,即出错和例外.

## 安装

```sh
npm install @eggjs/errors
```

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

## README

# @eggjs/错误

[![NPM version](https://img.shields.io/npm/v/@eggjs/errors.svg?style=flat-square)](https://npmjs.org/package/@eggjs/errors) [![Known Vulnerabilities](https://snyk.io/test/npm/@eggjs/errors/badge.svg?style=flat-square)](https://snyk.io/test/npm/@eggjs/errors) [![npm download](https://img.shields.io/npm/dm/@eggjs/errors.svg?style=flat-square)](https://npmjs.org/package/@eggjs/errors)

错误用于 [鸡蛋.js](https://eggjs.org/)

`@eggjs/errors` 提供两种错误,即错误和例外.

-   例外是系统错误, egg 将登录出错并丢出例外, 但会被 orrror 插件捕获 .
-   错误是商业错误,蛋会将其转化为响应.

## 安装

```bash
$ npm i @eggjs/errors --save
```

## 使用量

创建错误

```js
const { EggError, EggException } = require('@eggjs/errors');
let err = new EggError('egg error');
console.log(EggError.getType(err)); // ERROR
```

创建例外

```js
err = new EggException('egg exception');
console.log(EggException.getType(err)); // EXCEPTION
```

从普通错误对象导入错误

```js
err = new Error('normal error');
console.log(EggError.getType(err)); // BUILTIN
err = EggError.from(err);
console.log(EggError.getType(err)); // ERROR
```

### 自定义出错

错误可以扩展 .

```js
const { EggBaseError } = require('@eggjs/errors');

class CustomError extends EggBaseError {
  constructor(message) {
    super({ message, code: 'CUSTOM_CODE' });
  }
}
```

或者使用打字符,您可以自定义错误选项.

```js
import { EggBaseError, ErrorOptions } from '@eggjs/errors';

class CustomErrorOptions extends ErrorOptions {
  public data: object;
}

class CustomError extends EggBaseError<CustomErrorOptions> {
  public data: object;
  protected options: CustomErrorOptions;

  constructor(options?: CustomErrorOptions) {
    super(options);
    this.data = this.options.data;
  }
}
```

推荐使用消息而不是用户土地上的选项, 以方便开发者理解, 参见 [http 错误](https://github.com/eggjs/egg/blob/master/packages/errors/src/http/400.ts)。 。 。 .

### HTTP 错误

HTTP出错是将400~500状态代码转换为出错对象的BUILTIN出错. HttpError 扩展 EggBaseError 提供两个属性,即 `status` 财务报告和审定财务报表 `headers`· ;

```js
const { ForbiddenError } = require('@eggjs/errors');

const err = new ForbiddenError('your request is forbidden');
console.log(err.status); // 403
```

支持短名:

```js
const { E403 } = require('@eggjs/errors');

const err = new E403('your request is forbidden');
console.log(err.status); // 403
```

### 框架库错误

FrameworldBaseError是供鸡蛋框架/插件开发者抛出框架错误. 它可以通过 FrameworFormater 格式化

框架BaseError 扩展 EggBaseError 提供了三种属性,即 `module`, (中文)`serialNumber` 财务报告和审定财务报表 `errorContext`

框架BaseError 无法直接使用, 框架/ 插件应该像这样延伸

```js
const { FrameworkBaseError } = require('@eggjs/errors');

class EggMysqlError extends FrameworkBaseError {
  // module should be implement
  get module() {
    return 'EGG_MYSQL';
  }
}

const err = new EggMysqlError('error message', '01', { traceId: 'xxx' });
console.log(err.module); // EGG_MYSQL
console.log(err.serialNumber); // 01
console.log(err.code); // EGG_MYSQL_01
console.log(err.errorContext); // { traceId: 'xxx' }
```

#### 使用格式创建框架Error

使用静态方法 `.create(message: string, serialNumber: string | number, errorContext?: any)` 用于新建框架错误和格式

```js
const { FrameworkBaseError } = require('@eggjs/errors');

class EggMysqlError extends FrameworkBaseError {
  // module should be implement
  get module() {
    return 'EGG_MYSQL';
  }
}

const err = EggMysqlError.create('error message', '01', { traceId: 'xxx' });
console.log(err.message);
// =>
framework.EggMysqlError: error message [ https://eggjs.org/faq/EGG_MYSQL/01 ]
```

### 框架错误格式

FrammeErrorFormater 将在错误消息中附加 faq 向导 URL 。 当开发者遇到框架错误时, 这将有所帮助

faq 引导 url 格式 : `${faqPrefix}/${err.module}/${err.serialNumber}`, (中文(简体) ), `faqPrefix` 实值 `https://eggjs.org/faq` 默认。 可以通过设置扩展或覆盖 `process.env.EGG_FRAMEWORK_ERR_FAQ_PREFIX` (建议)或,对于后向相容性, `process.env.EGG_FRAMEWORK_ERR_FAQ_PERFIX` (传入.

```js
const { FrameworkErrorFormater } = require('@eggjs/errors');

class CustomErrorFormatter extends FrameworkErrorFormater {
  static faqPrefix = 'http://www.custom.com/faq';
}
```

#### 格式( err)

格式错误到信件, 它不会影响来源错误

```js
const { FrameworkBaseError, FrameworkErrorFormater } = require('@eggjs/errors');

class EggMysqlError extends FrameworkBaseError {
  // module should be implement
  get module() {
    return 'EGG_MYSQL';
  }
}

const message = FrameworkErrorFormater.format(new EggMysqlError('error message', '01'));
console.log(message);
// => message format like this
framework.EggMysqlError: error message [ https://eggjs.org/faq/EGG_MYSQL/01 ]
...stack
...
code: "EGG_MYSQL_01"
serialNumber: "01"
errorContext:
pid: 66568
hostname: xxx


// extends
class CustomErrorFormatter extends FrameworkErrorFormater {
  static faqPrefix = 'http://www.custom.com/faq';
}
const message = CustomErrorFormatter.format(new EggMysqlError('error message', '01'));
console.log(message);
// =>
framework.EggMysqlError: error message [ http://www.custom.com/faq/EGG_MYSQL/01 ]
...
```

#### 格式错误( err)

将 faq 引导 url 附加到错误的. message

```js
const { FrameworkBaseError, FrameworkErrorFormater } = require('@eggjs/errors');

class EggMysqlError extends FrameworkBaseError {
  // module should be implement
  get module() {
    return 'EGG_MYSQL';
  }
}

const err = FrameworkErrorFormater.formatError(new EggMysqlError('error message', '01'));
console.log(err.message); // error message [ https://eggjs.org/faq/EGG_MYSQL/01 ]
```

### 可用错误

```
BaseError
|- EggBaseError
|  |- EggError
|  |- HttpError
|  |  |- NotFoundError, alias to E404
|  |  `- ...
|  |- FrameworkBaseError
|  `- CustomError
`- EggBaseException
   |- EggException
   `- CustomException
```

## 问题和建议

请打开一个问题 [这里](https://github.com/eggjs/egg/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)。 。 。 .

## 许可证

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

## 贡献者

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

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

## 常见问题

### @eggjs/errors 是什么？

@eggjs/errors提供两种错误,即出错和例外\.

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

在项目目录运行 npm install @eggjs/errors，或使用 pnpm add / yarn add / bun add。

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

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

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

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

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

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

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

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

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

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

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

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