类:Jasmine

Jasmine(options)

配置、构建并执行 Jasmine 测试套件

构造函数

new Jasmine(options)

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

成员

alwaysListPendingSpecs

设置控制台报告器是否应在存在失败时列出挂起的规范。

(readonly) env :Env

Jasmine 环境。

类型
  • Env
参见

exitOnCompletion :boolean

当套件完成执行时,是否导致 Node 进程退出。

类型
  • boolean
默认值
  • true

方法

addHelperFile(filePath)

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

参数
名称 类型 说明
filePath string

要加载的文件的路径。

addMatchers(matchers)

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

注意:仅能从 beforeEachitbeforeAll 内调用此方法。

参数
名称 类型 说明
matchers Object

该对象的键将成为新的匹配器名称。

参见

addMatchingHelperFiles(patterns)

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

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

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

addMatchingSpecFiles(patterns)

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

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

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

addReporter(reporter)

将自定义报告器添加到 Jasmine 环境中。

参数
名称 类型 说明
reporter Reporter

要添加的报告器

参见

addSpecFile(filePath)

在运行套件时,添加需要加载的 spec 文件到列表中。

参数
名称 类型 说明
filePath string

要加载的文件的路径。

clearReporters()

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

configureDefaultReporter(options)

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

参数
名称 类型 说明
options ConsoleReporterOptions

coreVersion() → {string}

返回

正在使用的 jasmine-core 的版本

类型
string

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

运行测试套件。

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

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

spec 文件,用于替换之前配置的集合

filterString string <可选的>

用于过滤 spec 的正则表达式。如果指定,则只会运行具有匹配完整名称的 spec。

返回

在套件完成后解决的 Promise。

类型
Promise.<JasmineDoneInfo>

loadConfig(config)

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

参数
名称 类型 说明
config Configuration

(async) loadConfigFile(configFilePathopt)

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

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

Promise

provideFallbackReporter(reporter)

如果没有指定其他报告器,则提供回退报告器。

参数
名称 类型 说明
reporter

回退报告器

参见

randomizeTests(value)

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

参数
名称 类型 说明
value boolean

是否随机排列

seed(seed)

设置随机种子。

参数
名称 类型 说明
seed 数字

随机种子

showColors(value)

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

参数
名称 类型 说明
value boolean

是否显示颜色

stopOnSpecFailure(value)

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

参数
名称 类型 说明
value boolean

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

stopSpecOnExpectationFailure(value)

设置是否导致 spec 仅有一个期望值失败。

参数
名称 类型 说明
value boolean

是否导致 spec 仅有一个期望值失败