類別：Jasmine - Jasmine 測試框架

建構函式

new Jasmine(options)

參數

名稱	類型	說明
`options`	JasmineOptions \| undefined

範例

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

成員

(readonly) env :Env

Jasmine 環境。

類型

參閱

exitOnCompletion :布林值

在套件執行完畢時，是否讓 Node 程序退出。

附註：如果呼叫 onComplete，即使 exitOnCompletion 設為 true，Jasmine 仍然不會在套件完成時退出。

類型

布林值

預設值

true

方法

addHelperFile(filePath)

將一個 helper 檔案新增到套件執行時會載入的清單中。

參數

名稱	類型	說明
`filePath`	字串	要載入的檔案路徑。

addHelperFiles()

與 Jasmine#addMatchingHelperFiles 同義。

已過期

請改用 addMatchingHelperFiles、loadConfig 或 loadConfigFile。

addMatchers(matchers)

針對目前規格範圍新增自訂比對器。

附註：這只能從 beforeEach、it 或 beforeAll 內呼叫。

參數

名稱	類型	說明
`matchers`	物件	此物件的 Key 將會是新的比對器名稱。

參閱

自訂比對器

addMatchingHelperFiles(patterns)

將符合指定模式的檔案新增到 helper 檔案清單中。

參數

名稱	類型	說明
`patterns`	Array.<string>	helper 檔案路徑或與 helper 檔案相符的 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。否則，Node 流程通常會在 promise 完成前結束。

參數

名稱	類型	屬性	說明
`files`	Array.<string>	<選用>	要執行而非使用先前設定組的規格檔案
`filterString`	字串	<選用>	用於過濾規格的正規表示法。如果指定，則只執行符合完整名稱的規格。

回傳

當套件完成時會解決的 promise。

類型: Promise.<JasmineDoneInfo>

loadConfig(config)

從指定的物件載入設定。

參數

名稱	類型	說明
`config`	設定

loadConfigFile(configFilePathopt)

從指定的檔案載入設定。該檔案可以是 JSON 檔案或任何可透過需求載入並提供 Jasmine 設定為其預設匯出的 JS 檔案。

參數

名稱	類型	屬性	預設	說明
`configFilePath`	字串	<選用>	spec/support/jasmine.json

onComplete(onCompleteCallback)

註冊在執行結束時將呼叫的回呼函式。

注意事項：只能註冊一個回呼函式。回呼函式會在套件完成且結果已最終確定後呼叫，但未必要在 Jasmine 的所有清理作業完成前呼叫。呼叫此函式也將阻止 Jasmine 在套件執行結束時離開 Node 流程。

參數

名稱	類型	說明
`onCompleteCallback`	函式

已過期

將 exitOnCompletion 設定為 false，改使用從 execute 回傳的 promise。

provideFallbackReporter(reporter)

如果尚未指定其他報導者，則提供備用報導者。

參數

名稱	類型	說明
`reporter`		備用報導者

參閱

自訂報告器

randomizeTests(value)

設定是否要將規格順序隨機化。

參數

名稱	類型	說明
`值`	布林值	是否要隨機化

seed(seed)

設定隨機種子。

參數

名稱	類型	說明
`seed`	數字	隨機種子

showColors(value)

設定是否要在主控台報導者中顯示顏色。

參數

名稱	類型	說明
`值`	布林值	是否要顯示顏色

stopOnSpecFailure(value)

設定是否要在第一次規格失敗後停止執行套件。

參數

名稱	類型	說明
`值`	布林值	是否要在第一次規格失敗後停止執行套件

stopSpecOnExpectationFailure(value)

設定是否使規格只有單一驗證失敗。

參數

名稱	類型	說明
`值`	布林值	是否使規格只有單一驗證失敗