类: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 环境中。

参数
名称 类型 说明
报告器 报告器

要添加的报告器

覆盖
参见

addSpecFile(filePath)

将一个规范文件添加到套件执行时会加载的列表中。

参数
名称 类型 说明
filePath string

要加载的文件的路径。

继承自

alwaysListPendingSpecs(value)

设置控制台报告器是否应在存在失败时列出待处理规范。

参数
名称 类型 说明
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> <可选>

要运行的规范文件,而非之前配置的集合

filterString string <可选>

用于过滤规范的正则表达式。如果指定,只有具有匹配全名的规范才会运行。

返回

当套件完成时解决的 promise。

类型
Promise.<JasmineDoneInfo>

loadConfig(config)

从指定对象加载配置。

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

loadConfigFile(configFilePathopt)

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

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

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

Promise

provideFallbackReporter(reporter)

如果未指定其他报告器,则提供后备报告器。

参数
名称 类型 说明
报告器

后备报告器

参见

randomizeTests(value)

设置是否随机化规范的顺序。

参数
名称 类型 说明
value boolean

是否随机化

seed(seed)

将随机种子设置为。

参数
名称 类型 说明
种子 数字

随机种子

showColors(value)

设置是否在控制台报表中显示颜色。

参数
名称 类型 说明
value boolean

是否显示颜色

继承自

stopOnSpecFailure(value)

设置是否在首次规格失败后停止执行集成测试。

参数
名称 类型 说明
value boolean

是否在首次规格失败后停止执行集成测试

stopSpecOnExpectationFailure(value)

设置是否使规格仅包含一个期望值失败。

参数
名称 类型 说明
value boolean

是否使规格仅包含一个期望值失败

verbose(value)

设置是否以详细信息模式运行,它将打印对调试配置问题有用的信息。

参数
名称 类型 说明
value boolean

是否以详细信息模式运行

继承自