類別: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 陣列.<字串>

與輔助檔案相符的輔助檔案路徑陣列或 glob。相對於規格目錄,將評估每個路徑或 glob。

繼承自

addMatchingSpecFiles(patterns)

將符合指定樣式的檔案新增至規範檔案的清單中。

參數
名稱 類別 說明
patterns 陣列.<字串>

與規範檔案相符的規範檔案路徑陣列或 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 陣列.<字串> <optional>

要執行的規格檔案,而非先前設定的集合

filterString string <optional>

用於過濾規格的正則表達式。如果指定,只會執行符合完整名稱的規格。

傳回

在套件完成時解決的 Promise。

類別
Promise.<JasmineDoneInfo>

loadConfig(config)

從指定物件載入設定。

參數
名稱 類別 說明
config 設定
繼承自

loadConfigFile(configFilePathopt)

從指定檔案載入設定。檔案可以是 JSON 檔案,或任何可作為模組載入的 JS 檔案,並提供 Jasmine 設定作為其預設輸出。

設定檔案將透過動態 import() 載入,除非此 Jasmine 執行個體已設定為 {jsLoader: 'require'}。動態 import() 支援 ES 模組以及幾乎所有 CommonJS 模組。

參數
名稱 類別 屬性 預設 說明
configFilePath string <optional>
spec/support/jasmine.json
繼承自
傳回

承諾

provideFallbackReporter(reporter)

如果未指定其他報告員,提供後備報告員。

參數
名稱 類別 說明
reporter

後備報告員

請參閱

randomizeTests(value)

設定是否要隨機排列規格順序。

參數
名稱 類別 說明
value boolean

是否隨機排列

seed(seed)

設定隨機產生種子。

參數
名稱 類別 說明
種子 number

隨機產生種子

showColors(value)

設定是否要在主控台報告員中顯示色彩。

參數
名稱 類別 說明
value boolean

是否顯示色彩

繼承自

stopOnSpecFailure(value)

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

參數
名稱 類別 說明
value boolean

是否在第一個規格失敗後停止執行套件

stopSpecOnExpectationFailure(value)

設定是否使規格只有一個期望失敗。

參數
名稱 類別 說明
value boolean

是否使規格只有一個期望失敗

verbose(value)

設定是否以詳細模式執行,這會列印可能有用的資訊,供除錯設定問題之用。

參數
名稱 類別 說明
value boolean

是否以詳細模式執行

繼承自