Documentation Home
此页面描述了 Jasmine 的预发布版本 (5.0.0-beta.0)。在最终的 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>

辅助文件路径或 globs 的数组,与辅助文件匹配。每个路径或 glob 将相对于规范目录进行评估。

从以下继承

addMatchingSpecFiles(patterns)

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

参数
名称 类型 描述
patterns Array.<string>

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

从以下继承

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> 和lt;可选和gt;

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

filterString string 和lt;可选和gt;

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

返回

套件完成后解决的承诺。

类型
Promise.<JasmineDoneInfo>

loadConfig(config)

从指定的对象加载配置。

参数
名称 类型 描述
config Configuration
从以下继承

loadConfigFile(configFilePathopt)

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

参数
名称 类型 属性 默认值 描述
configFilePath string 和lt;可选和gt;
spec/support/jasmine.json
从以下继承
返回

承诺

provideFallbackReporter(reporter)

在没有指定其他报告程序的情况下提供备用报告程序。

参数
名称 类型 描述
reporter

备用报告程序

参见

randomizeTests(值)

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

参数
名称 类型 描述
value boolean

是否随机分配

seed(种子)

设置随机种子。

参数
名称 类型 描述
种子 数字

随机种子

showColors(值)

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

参数
名称 类型 描述
value boolean

是否显示颜色

从以下继承

stopOnSpecFailure(值)

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

参数
名称 类型 描述
value boolean

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

stopSpecOnExpectationFailure(值)

设置是否导致规范只存在一个期望失败。

参数
名称 类型 描述
value boolean

是否导致规范只存在一个期望失败