Documentation Home
此页面描述的是 Jasmine 的预发布版本(5.0.0-alpha.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>

助手文件路径或与助手文件匹配的 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>}

运行测试组件。

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

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

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

filterString string <可选>

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

返回值

在组件完成后解决的 Promise。

类型
Promise.<JasmineDoneInfo>

loadConfig(config)

从指定的对象加载配置。

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

loadConfigFile(configFilePathopt)

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

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

Promise

provideFallbackReporter(reporter)

如果没有指定其他报告程序,请提供一个后备报告程序。

参数
名称 类型 说明
reporter

后备报告程序

参见

randomizeTests(value)

设置是否随机排列规格的顺序。

参数
名称 类型 说明
value boolean

是否随机排列

seed(seed)

设置随机种子。

参数
名称 类型 说明
seed 数字

随机种子

showColors(value)

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

参数
名称 类型 说明
value boolean

是否显示颜色

继承自

stopOnSpecFailure(value)

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

参数
名称 类型 说明
value boolean

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

stopSpecOnExpectationFailure(value)

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

参数
名称 类型 说明
value boolean

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