# assertion-error 中文文档

规范地址：https://npmcn.com/package/assertion-error/

版本：2\.0\.1
npm 元数据更新时间：2024-05-09T08:51:10.880Z
中文译文更新时间：2026-11-05T14:37:21.425Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：5.8 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=12
- 运行依赖：0 个
- 首次发布：2013-04-07T22:59:41.018Z
- 最新版本发布：2023-10-18T18:04:13.507Z
- 近 30 天下载量：494991962（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

用于执行标准化 AssertionError 规格的测试和验证框架的错误构造器 .

## 安装

```sh
npm install assertion-error
```

也可以使用：`pnpm add assertion-error`、`yarn add assertion-error`、`bun add assertion-error`

## README

Assertion Error and Assertion Result class. (原始内容存档于2018-09-29). Assertion Error and Assertion Result class.

 [![build:?](https://github.com/chaijs/assertion-error/actions/workflows/nodejs.yml/badge.svg)](https://github.com/chaijs/assertion-error/actions)[![downloads:?](https://img.shields.io/npm/dm/assertion-error.svg) ](https://www.npmjs.com/package/assertion-error)![devDependencies:none](https://img.shields.io/badge/dependencies-none-brightgreen)

## 什么是Assertion Error? (美国英语)?

Assertion Error是一个包含两个类的模块: `AssertionError`,哪个 是一个实例 `Error`,以及 `AssertionResult` 这不是一个实例 错误.

如果函数“ 成功” , 这些功能对于函数返回可能有用 返回一个 `AssertionResult` 如果函数未返回(或投掷) `AssertionError`。 。 。 .

两者 `AssertionError` 财务报告和审定财务报表 `AssertionResult` 执行 `Result` 接口 :

```typescript
interface Result {
  name: "AssertionError" | "AssertionResult";
  ok: boolean;
  toJSON(...args: unknown[]): Record<string, unknown>;
}
```

所以如果一个函数返回 `AssertionResult | AssertionError` 很容易检查 _哪个_ 一个通过检查返回 `.name` 或者说 `.ok`,或检查 `instanceof Error`。 。 。 .

## 安装

### 节点.js

`assertion-error` 可在 [无](http://npmjs.org/)。 。 。 .

```
$ npm install --save assertion-error
```

### 德诺

`assertion_error` 可在 [德诺.兰](https://deno.land/x/assertion_error)

```typescript
import {
  AssertionError,
  AssertionResult,
} from "https://deno.land/x/assertion_error@2.0.0/mod.ts";
```

## 常见问题

### assertion-error 是什么？

用于执行标准化 AssertionError 规格的测试和验证框架的错误构造器 \.

### 如何安装 assertion-error？

在项目目录运行 npm install assertion-error，或使用 pnpm add / yarn add / bun add。

### assertion-error 支持 TypeScript 吗？

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

### assertion-error 支持 ESM 还是 CommonJS？

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

### assertion-error 需要什么版本的 Node\.js？

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

### assertion-error 可以商用吗？

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

### assertion-error 的下载量有多少？

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

### assertion-error 还在维护吗？

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