# jest-circus 中文文档

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

版本：30\.5\.2
npm 元数据更新时间：2026-09-18T13:56:43.909Z
中文译文更新时间：2026-11-05T16:32:01.349Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：167 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：^18\.14\.0 \|\| ^20\.0\.0 \|\| ^22\.0\.0 \|\| \>=24\.0\.0
- 运行依赖：20 个
- 首次发布：2017-06-02T14:31:17.306Z
- 最新版本发布：2026-09-18T13:56:43.726Z
- 近 30 天下载量：208428009（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：276（近 12 个月 7 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install jest-circus
```

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

## README

# ![](https://jestjs.io/img/jest.png) ![](https://jestjs.io/img/circus.png)

恶作剧

Jest的下一代测试跑手

## 概览

马戏团是Jest基于通量的测试跑车,速度快,可维护,可以简单延伸.

马戏团允许您通过任意一个可选的事件处理器绑定事件 [自定义环境](https://jestjs.io/docs/configuration#testenvironment-string)见 [类型定义](https://github.com/jestjs/jest/blob/main/packages/jest-types/src/Circus.ts) 以了解有关事件的更多信息和现有国家数据.

```ts
import type {Event, State} from 'jest-circus';
import {TestEnvironment as NodeEnvironment} from 'jest-environment-node';

class MyCustomEnvironment extends NodeEnvironment {
  //...

  async handleTestEvent(event: Event, state: State) {
    if (event.name === 'test_start') {
      // ...
    }
  }
}
```

突变事件或状态数据目前不支持,可能在未来发布时引起出乎意料的行为或中断而无预警. 新事件,事件数据和(或)状态数据不会被视为突破性变化,可以在任何小发布中被添加.

说明 `jest-circus` 试跑者会暂停 直到一个承诺从 `handleTestEvent` 得到满足. **然而,有一些事件不符合这一规则,即:**数字 : `start_describe_definition`, (中文(简体) ), `finish_describe_definition`, (中文(简体) ), `add_hook`, (中文(简体) ), `add_test` 或者说 `error` (对于最新的列表,您可以查看) [在类型定义中同步Event 类型](https://github.com/jestjs/jest/blob/main/packages/jest-types/src/Circus.ts)) (中文(简体) ). 这是由后向兼容性原因和 `process.on('unhandledRejection', callback)` 签名,但这通常不应成为大多数使用情况下的问题.

## 安装

> 注:截至第27章, `jest-circus` 是默认的测试运行器,所以不需要安装即可使用.

安装 `jest-circus` 使用线条 :

```bash
yarn add --dev jest-circus
```

或者通过 npm:

```bash
npm install --save-dev jest-circus
```

## 配置

配置要使用的游戏 `jest-circus` 通过 [`testRunner`](https://jestjs.io/docs/configuration#testrunner-string) 选项 :

```json
{
  "testRunner": "jest-circus/runner"
}
```

或者通过CLI:

```bash
jest --testRunner='jest-circus/runner'
```

## 常见问题

### 如何安装 jest-circus？

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

### jest-circus 支持 TypeScript 吗？

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

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

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

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

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

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

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

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

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

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

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