# @directus/errors 中文文档

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

版本：3\.0\.0
npm 元数据更新时间：2026-10-07T18:42:18.424Z
中文译文更新时间：2026-11-12T10:49:11.578Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：33.3 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2023-06-27T21:46:47.614Z
- 最新版本发布：2026-10-07T18:42:18.077Z
- 近 30 天下载量：182131（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：33（近 12 个月 10 个）

## 中文简介

在代码库周围创建一致的错误对象

## 安装

```sh
npm install @directus/errors
```

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

## README

# @ directus/ errors (帮助)

用于帮助创建和检查Directus出错的功能.

## 安装

```
pnpm add @directus/errors
```

## 使用量

### 创建新错误类

```
createError(code: string, message: string | (T) => string, status = 500): DirectusErrorConstructor<T>
```

```ts
import { createError } from '@directus/errors';

const ForbiddenError = createError('FORBIDDEN', "You don't have permissions to see this.", 403);

throw new ForbiddenError();
```

您可以为错误类别配置额外的扩展名, 该扩展名应当发送给终端用户 :

```ts
import { createError } from '@directus/errors';

interface ForbiddenErrorExtensions {
    collection: string;
    field: string;
}

const ForbiddenError = createError<ForbiddenErrorExtensions>(
    'FORBIDDEN',
    "You don't have permissions to see this.",
    403,
);

throw new ForbiddenError({
    collection: 'articles',
    field: 'title',
});
```

然后也可以使用这些扩展生成出错误消息 :

```ts
import { createError } from '@directus/errors';

interface ForbiddenErrorExtensions {
    collection: string;
    field: string;
}

const messageConstructor = (extensions: ForbiddenErrorExtensions) =>
    `You don't have permissions to see "${extensions.field}" in "${extensions.collection}".`;

const ForbiddenError = createError<ForbiddenErrorExtensions>('FORBIDDEN', messageConstructor, 403);

throw new ForbiddenError({
    collection: 'articles',
    field: 'title',
});
```

### 检查给定的参数是否为有效的 DirectusError 实例

```ts
import { isDirectusError, createError } from '@directus/errors';

const ForbiddenError = createError('FORBIDDEN', "You don't have permissions to see this.", 403);

isDirectusError(new ForbiddenError()); // true
isDirectusError(new Error()); // false
```

## 常见问题

### @directus/errors 是什么？

在代码库周围创建一致的错误对象

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

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

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

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

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

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

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

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

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

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

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

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