类:Jasmine

Jasmine(options)

配置、构建并执行 Jasmine 测试套件。
另请参见 ParallelRunner,它为并行执行提供了等效的功能。

构造函数

new Jasmine(options)

参数
名称 类型 说明
options JasmineOptions | undefined
示例
const Jasmine = require('jasmine');
const jasmine = new Jasmine();

扩展

成员

(readonly) env :Env

Jasmine 环境。

类型
  • Env
请参阅

exitOnCompletion :boolean

在套件执行完毕时是否让 Node 进程退出。

类型
  • boolean
覆盖
默认值
  • true

方法

addHelperFile(filePath)

将帮助程序文件添加到将在套件执行时加载的文件列表中。

参数
名称 类型 说明
filePath string

要加载的文件的路径。

继承自

addMatchers(matchers)

为当前范围的规范添加自定义匹配器。

注意: 这只能在 beforeEachitbeforeAll 中调用。

参数
名称 类型 说明
matchers 对象

此对象中的键将是新的匹配器名称。

请参阅

addMatchingHelperFiles(patterns)

将匹配指定模式的文件添加到帮助程序文件列表中。

参数
名称 类型 说明
patterns Array.<string>

一个帮助程序文件路径或匹配帮助程序文件的 glob 数组。每个路径或 glob 都将相对于规范目录进行评估。

继承自

addMatchingSpecFiles(patterns)

将匹配指定模式的文件添加到规范文件列表中。

参数
名称 类型 说明
patterns Array.<string>

一个规范文件路径或匹配规范文件的 glob 数组。每个路径或 glob 都将相对于规范目录进行评估。

继承自

addReporter(reporter)

向 Jasmine 环境中添加自定义报告程序。

参数
名称 类型 说明
reporter 报告程序

要添加的报告程序

覆盖
请参阅

addSpecFile(filePath)

在套件执行时将 spec 文件添加到要加载的列表中。

参数
名称 类型 说明
filePath string

要加载的文件的路径。

继承自

alwaysListPendingSpecs(value)

设置控制台报告程序是否应列出未决 spec,即使存在失败。

参数
名称 类型 说明
value boolean
继承自

clearReporters()

清除所有已注册的报告程序。

覆盖

configureDefaultReporter(options)

如果未指定任何其他报告程序,则配置已安装的默认报告程序。

参数
名称 类型 说明
options ConsoleReporterOptions
继承自

coreVersion() → {string}

返回

正在使用的 jasmine-core 版本

类型
string

(async) execute(filesopt, filterStringopt) → {Promise.<JasmineDoneInfo>}

运行测试套件。

注意:如果你打算使用返回的 Promise,将 exitOnCompletion 设置为 false。否则,Node 进程通常会在 Promise 解决之前退出。

参数
名称 类型 属性 说明
files Array.<string> <可选>

要运行的 Spec 文件,而不是之前配置的集合

filterString string <可选>

用于筛选 spec 的正则表达式。如果指定了此表达式,则只会运行与之匹配的全名称 spec。

返回

在套件完成时解析的 Promise。

类型
Promise.<JasmineDoneInfo>

loadConfig(config)

从指定的对象加载配置。

参数
名称 类型 说明
config Configuration
继承自

loadConfigFile(configFilePathopt)

从指定的文件加载配置。该文件可以是 JSON 文件或任何可加载为模块并且提供 Jasmine 配置作为其默认导出的 JS 文件。

除非当前 Jasmine 实例已经配置了 {jsLoader: 'require'},否则将通过动态 import() 加载配置文件。动态 import() 支持 ES 模块以及几乎所有 CommonJS 模块。

参数
名称 类型 属性 默认 说明
configFilePath string <可选>
spec/support/jasmine.json
继承自
返回

Promise

provideFallbackReporter(reporter)

如果未指定任何其他报告程序,请提供后备报告程序。

参数
名称 类型 说明
reporter

后备报告程序

请参阅

randomizeTests(value)

设置是否对 spec 的顺序进行随机排序。

参数
名称 类型 说明
value boolean

是否随机化

seed(seed)

设置随机种子。

参数
名称 类型 说明
seed 数字

随机种子

showColors(value)

设置是否在控制台报告工具中显示颜色。

参数
名称 类型 说明
value boolean

是否显示颜色

继承自

stopOnSpecFailure(value)

设置是否在第一个规格失败后停止执行套件。

参数
名称 类型 说明
value boolean

是否在第一个规格失败后停止执行套件

stopSpecOnExpectationFailure(value)

设置是否令规格仅有一个期望失败。

参数
名称 类型 说明
value boolean

是否令规格仅有一个期望失败

verbose(value)

设置是否以详细模式运行,这样会打印信息,可能对调试配置问题有用。

参数
名称 类型 说明
value boolean

是否以详细模式运行

继承自