# jest-util 中文文档

规范地址：https://npmcn.com/package/jest-util/

版本：30\.5\.1
npm 元数据更新时间：2026-09-01T07:58:45.000Z
中文译文更新时间：2026-11-05T14:42:40.396Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：57.5 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：^18\.14\.0 \|\| ^20\.0\.0 \|\| ^22\.0\.0 \|\| \>=24\.0\.0
- 运行依赖：6 个
- 首次发布：2016-02-16T19:34:20.253Z
- 最新版本发布：2026-09-01T07:58:44.770Z
- 近 30 天下载量：465469569（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：277（近 12 个月 5 个）

## 中文简介

此软件包是公用设施和辅助功能的集合

## 安装

```sh
npm install jest-util
```

也可以使用：`pnpm add jest-util`、`yarn add jest-util`、`bun add jest-util`

## README

# `@jest/utils`

此软件包是公用设施和辅助功能的集合

## `ErrorWithStack`

此自定义错误类在您需要捕获错误的堆栈痕量并提供错误消息的额外上下文时会有所帮助 。 默认情况下, JavaScript 错误只抓取被抛出时的堆栈痕量,但此类允许您通过调用其构建器在代码的任意点抓取堆栈痕量.

## `clearLine`

它确保清理操作只在终端环境中运行时进行,而不是输出被重定向到文件或其他非终端目的地时进行.

## `convertDescriptorToString`

它定义了一个名为 `convertDescriptorToString` 以描述符作为输入,然后根据类型将其转换为字符串。 它处理各种类型,例如函数,数字,字符串,以及未定义的值. 如果输入与其中任何类型不相匹配,则会以描述性消息来抛出错误.

## `createDirectory`

它创建了新的目录,同时也允许创建被嵌入的目录.

## `deepCyclicCopy`

这个 `deepCyclicCopy` 函数提供JavaScript对象和阵列的深层复制,包括处理循环引用. 它通过下列方式提供可选定制: `DeepCyclicCopyOptions` 参数,允许用户黑名单属性并保存对象原型. 该函数返回一个完全独立的输入数据结构深拷贝.

## `formatTime`

此函数可用于为可读性使用适当的 SI 单位前缀格式化时间值. 它在各种单位(如毫秒,微秒,纳米秒)中表示时间,同时确保格式一致和人可读.

## `globsToMatcher`

该代码高效地将一列表的光彩图案转换成一个可重复使用的功能,用于将路径与这些图案相匹配,同时考虑到被否定的图案并优化性能.

## `installCommonGlobals`

设置了Jest测试框架所需的各种全球变量和功能. 它确保在保持与环境的全球对象相容的同时,为测试情景而适当设置这些全局.

## `interopRequireDefault`

通过适当处理默认导出行为,提供了一种确保ES模块和C通JS模块相容的方法.

## `invariant`

它用来断言某一条件属实。 它常被作为开发期间的调试援助来捕捉预期条件未得到满足的情况.

## `isInteractive`

检查当前环境是否适合交互终端交互.

## `isNonNullable`

用于缩小TypeScript代码块内的变量类型,确保可以安全地假设该值是不可忽略的. 这可以帮助避免与无效或未定义值相关的运行时间错误.

## `isPromise`

它有助于确定一个给定的值是否符合类似“承诺”的对象的结构,后者通常具有 `then` 方法。 在与同步代码合作以确保正确处理承诺时,这可能是有益的.

## `pluralize`

此函数用于在文本输出中轻松生成语法上正确的短语,这些短语取决于项目的计数. 它确保在必要时该词的正确复数化.

## `preRunMessage`

这些功能用于交互式命令行工具或脚本,这些工具或脚本向用户提供信息信息,同时确保一个干净和反应灵敏的界面.

## `replacePathSepForGlob`

该函数需要字符串 `path` 在路径中作为输入并用前斜线取而代之。 曾经将文件路径正常化以兼容 glob 模式,确保不同操作系统路径表达的一致性.

## `requireOrImportModule`

这个功能提供了一种统一的方式来加载模块,无论它们是使用"共同JS"还是"无害环境管理语法". 它确保在必要时一致应用默认导出,使用户能够使用可能使用不同模块系统的模块.

## `setGlobal`

用于设置全局对象内指定值的属性 。 它通过接受不同类型的全局对象作为输入,在浏览器类和Node.js两种环境中工作.

## `specialChars`

它定义了处理终端环境中特定平台行为的常数和条件值. 它决定了当前平台是否是Windows ("win32"),并相应设置了各种符号和终端屏幕清除出逃序列的常数,确保了Windows操作系统和非Windows操作系统中的正确显示和行为.

## `TestPathPatterns`

此类取出测试模式,并提供API,用于决定一个测试是否与任何模式相匹配.

## `tryRealpath`

用于解决给定路径的真实路径,但如果路径不存在或是一个目录,则不会抛出错误并返回原始路径字符串. 在有些路径可能不存在或可能是目录的情景中,这可能有助于优雅地处理路径解析.

## 常见问题

### jest-util 是什么？

此软件包是公用设施和辅助功能的集合

### 如何安装 jest-util？

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

### jest-util 支持 TypeScript 吗？

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

### jest-util 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### jest-util 需要什么版本的 Node\.js？

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

### jest-util 可以商用吗？

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

### jest-util 的下载量有多少？

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

### jest-util 还在维护吗？

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