# @brillout/libassert 中文文档

规范地址：https://npmcn.com/package/%40brillout/libassert/

版本：0\.5\.8
npm 元数据更新时间：2022-05-20T19:20:27.044Z
中文译文更新时间：2026-11-08T15:30:44.165Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：15 kB，32 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2020-11-26T12:28:44.383Z
- 最新版本发布：2022-05-20T19:20:26.982Z
- 近 30 天下载量：158110（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 0 个）

## 中文简介

图书馆作者请求.

## 安装

```sh
npm install @brillout/libassert
```

也可以使用：`pnpm add @brillout/libassert`、`yarn add @brillout/libassert`、`bun add @brillout/libassert`

## README

# `@brillout/libassert`

微小的零依赖性工具,用于图书馆作者创建带有干净的跟踪痕迹的断言功能.

-   完整的堆栈痕迹。 (`Error.stackTraceLimit = Infinity;` _仅限_ (a) 说明错误。 )
-   清理了堆放痕迹 (拳堆线指断言破解码,无用堆线被剥去
-   错误消息保证不包含新行 .

```ts
import { newError } from "@brillout/libassert";

export { assert };

function assert(condition: unknown): asserts condition {
  if (condition) {
    return;
  }

  const err = newError(
    `[${libName}][Internal Error] Something unexpected happened, please open a GitHub issue.`;
  );

  throw err;
}
```

通话 `newError(errorMessage)` 与 `new Error(errorMessage)` 但:

-   如上所述,堆放痕迹是完整和清理的.
-   `errorMessage` 禁止包含新行.

您可以创建各种断言功能, 例如 `assertUsage` 或者说 `assertWarning`数字 :

```ts
import { newError } from "@brillout/libassert";

export { assert, assertUsage, assertWarning };

const libName = "My Awesome Library";

// Assertions that are expected to always be true (also known as "invariants")
function assert(condition: unknown): asserts condition {
  if (condition) {
    return;
  }

  const err = newError(
    `[${libName}][Internal Error] Something unexpected happened, please open a GitHub issue.`;
  );

  throw err;
}

// Wrong usage of your library
function assertUsage(
  condition: unknown,
  errorMessage: string
): asserts condition {
  if (condition) {
    return;
  }

  const err = newError(prefix: `[${libName}][Wrong Usage] ${errorMessage}`);

  throw err;
}

// Something unexpected happened but it is non-critical and doesn't
// warrant interrupting code execution.
function assertWarning(condition: unknown, errorMessage: string): void {
  if (condition) {
    return;
  }

  const err = newError(`[${libName}][Warning] ${errorMessage}`);

  console.warn(err);
}
```

## 常见问题

### @brillout/libassert 是什么？

图书馆作者请求\.

### 如何安装 @brillout/libassert？

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

### @brillout/libassert 支持 TypeScript 吗？

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

### @brillout/libassert 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @brillout/libassert 可以商用吗？

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

### @brillout/libassert 的下载量有多少？

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

### @brillout/libassert 还在维护吗？

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