类: Jasmine - Jasmine 中文

构造函数

new Jasmine(options)

参数

名称	类型	说明
`options`	JasmineOptions \| undefined

示例

const Jasmine = require('jasmine');
const jasmine = new Jasmine();

成员

(readonly) env :Env

Jasmine 环境。

类型

参见

exitOnCompletion :boolean

套件执行完毕后是否使节点进程退出。

注意: 如果调用了 onComplete，即使 exitOnCompletion 设置为 true，Jasmine 在套件完成时也不会退出。

类型

布尔值

默认值

true

方法

addHelperFile(filePath)

将帮助文件添加到将在套件执行时加载的列表中。

参数

名称	类型	说明
`filePath`	字符串	要加载的文件的路径。

addHelperFiles()

与 Jasmine#addMatchingHelperFiles 同义

已弃用

请改用 addMatchingHelperFiles、loadConfig 或 loadConfigFile。

addMatchers(matchers)

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

注意: 此项仅可在 beforeEach、it 或 beforeAll 中调用。

参数

名称	类型	说明
`matchers`	对象	此对象中的键将成为新的匹配器名。

参见

自定义匹配器

addMatchingHelperFiles(patterns)

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

参数

名称	类型	说明
`patterns`	Array.<string>	与帮助文件匹配的帮助文件路径或 glob 数组。每个路径或 glob 都将在规范目录下进行评估。

addMatchingSpecFiles(patterns)

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

参数

名称	类型	说明
`patterns`	Array.<string>	一个规范文件路径或匹配规范文件的glob 数组。每个路径或 glob 将相对于规范目录进行评估。

addReporter(reporter)

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

参数

名称	类型	说明
`reporter`	报告器	要添加的报告器

参见

自定义报告器

addSpecFile(filePath)

在执行套件时，向列表添加一个特性的文件。

参数

名称	类型	说明
`filePath`	字符串	要加载的文件的路径。

addSpecFiles()

Jasmine#addMatchingSpecFiles 的同义词

已弃用

改用 addMatchingSpecFiles、loadConfig 或 loadConfigFile。

clearReporters()

清除所有注册的报告器。

configureDefaultReporter(options)

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

参数

名称	类型	说明
`options`	ConsoleReporterOptions

coreVersion() → {string}

返回值

使用的 jasmine-core 的版本

类型: 字符串

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

运行测试套件。

注意：如果你打算使用已返回 promise，则把 exitOnCompletion 设为 false。否则，在 promise 得到解决之前，Node 进程通常会退出。

参数

名称	类型	属性	说明
`files`	Array.<string>	<可选>	特性的文件用以运行，而不是先前配置的集合
`filterString`	字符串	<可选>	用于过滤规范的 Regex。如果指定，只运行全名匹配的规范。

返回值

套件执行完成后解决的 Promise。

类型: Promise.<JasmineDoneInfo>

loadConfig(config)

从指定对象加载配置。

参数

名称	类型	说明
`config`	配置

loadConfigFile(configFilePathopt)

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

参数

名称	类型	属性	默认值	说明
`configFilePath`	字符串	<可选>	spec/support/jasmine.json

onComplete(onCompleteCallback)

注册一个执行完成后调用的回调函数。

注意：只能注册一个回调。套件完成后回调将被调用，结果已经完成，但并不一定是在所有 Jasmine 的清理完成后。调用此函数还可以防止 Jasmine 在套件执行结束后退出 Node 进程。

参数

名称	类型	说明
`onCompleteCallback`	函数

已弃用

将 exitOnCompletion 设置为 false，然后使用 execute 返回的 Promise。

provideFallbackReporter(reporter)

如果未指定其他报告器，提供一个后备报告器。

参数

名称	类型	说明
`reporter`		后备报告器

参见

自定义报告器

randomizeTests(value)

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

参数

名称	类型	说明
`value`	布尔值	是否随机化

seed(seed)

设置随机种子。

参数

名称	类型	说明
`seed`	数字	随机种子

showColors(value)

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

参数

名称	类型	说明
`value`	布尔值	是否显示颜色

stopOnSpecFailure(value)

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

参数

名称	类型	说明
`value`	布尔值	是否在第一个规范失败后停止套件执行

stopSpecOnExpectationFailure(value)

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

参数

名称	类型	说明
`value`	布尔值	是否导致规范只出现一个预期失败