Skip to content

TestModule

TestModule 类表示项目中的单个模块。此类仅在主线程中可用。如果你正在处理运行时任务,请参阅 “Runner API”

TestModule 实例始终具有一个 type 属性,其值为 module。你可以使用它来区分不同的任务类型:

ts
if (task.type === 'module') {
  task // TestModule
}

扩展 Suite 的方法

TestModule 类继承了 TestSuite 的所有方法和属性。本指南将列出 TestModule 独有的方法和属性。

moduleId

这通常是一个绝对的 Unix 文件路径(即使在 Windows 上也是如此)。如果文件不在磁盘上,它可以是一个虚拟 ID。此值对应于 Vite 的 ModuleGraph ID。

ts
'C:/Users/Documents/project/example.test.ts' // ✅
'/Users/mac/project/example.test.ts' // ✅
'C:\\Users\\Documents\\project\\example.test.ts' // ❌

state

ts
function state(): TestModuleState

testSuite.state() 的工作方式相同,但如果模块尚未执行,还可以返回 queued

diagnostic

ts
function diagnostic(): ModuleDiagnostic

关于模块的有用信息,例如持续时间、内存使用等。如果模块尚未执行,所有诊断值将返回 0

ts
interface ModuleDiagnostic {
  /**
   * The time it takes to import and initiate an environment.
   */
  readonly environmentSetupDuration: number
  /**
   * The time it takes Vitest to setup test harness (runner, mocks, etc.).
   */
  readonly prepareDuration: number
  /**
   * The time it takes to import the test module.
   * This includes importing everything in the module and executing suite callbacks.
   */
  readonly collectDuration: number
  /**
   * The time it takes to import the setup module.
   */
  readonly setupDuration: number
  /**
   * Accumulated duration of all tests and hooks in the module.
   */
  readonly duration: number
}

Released under the MIT License.