Documentation Home
此页面描述了 Jasmine(5.0.0-alpha.1)的 Pre 版本。在最终版本 5.0 发布之前,可能会有一些其他更改,包括重大修改。

类: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)

将规范文件添加到该列表中,以便在执行测试套件时加载它。

参数
名称 类型 说明
filePath string

要加载的文件的路径。

从以下继承

alwaysListPendingSpecs(value)

设置控制台报告器是否应在出现故障时列出挂起的规范。

参数
名称 类型 说明
value boolean
从以下继承

clearReporters()

清除所有已注册的报告器。

覆盖

configureDefaultReporter(options)

如果没有指定其他报告器,则配置安装的默认报告器。

参数
名称 类型 说明
options ConsoleReporterOptions
从以下继承

coreVersion() → {string}

返回

正在使用的 jasmine-core 的版本

类型
string

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

运行测试套件。

注意:如果您打算使用返回的承诺,请将 exitOnCompletion 设置为 false。否则,通常会在承诺结算之前退出 Node 进程。

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

要运行的规范文件,而不是先前配置的规范文件

filterString string <可选>

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

返回

测试套件完成后就会解决的承诺。

类型
Promise.<JasmineDoneInfo>

loadConfig(config)

从指定的对象中加载配置。

参数
名称 类型 说明
config Configuration
从以下继承

loadConfigFile(configFilePathopt)

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

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

Promise

provideFallbackReporter(reporter)

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

参数
名称 类型 说明
reporter

备用报告器

查看

randomizeTests(value)

设置是否以随机顺序运行规范。

参数
名称 类型 说明
value boolean

是否以随机顺序运行

seed(seed)

设置随机种子。

参数
名称 类型 说明
seed number

随机种子

showColors(value)

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

参数
名称 类型 说明
value boolean

是否显示颜色

从以下继承

stopOnSpecFailure(value)

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

参数
名称 类型 说明
value boolean

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

stopSpecOnExpectationFailure(value)

设置是否导致规范仅有一个预期失败。

参数
名称 类型 说明
value boolean

是否导致规范仅有一个预期失败