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 Reporter

要加入的報告程式

覆寫
請參閱

addSpecFile(filePath)

當套件執行時,將規範檔案加入將載入的清單中。

參數
名稱 類型 說明
filePath string

要載入的檔案路徑。

繼承自

alwaysListPendingSpecs(value)

設定主控台報表員即使有失敗也應該列出待執行規範。

參數
名稱 類型 說明
價值 boolean
繼承自

clearReporters()

清除所有已註冊的報表員。

覆寫

configureDefaultReporter(options)

如果未指定其他報表員,則設定安裝的預設報表員。

參數
名稱 類型 說明
options ConsoleReporterOptions
繼承自

coreVersion() → {string}

回傳值

已使用的 jasmine-core 版本

類型
string

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

執行測試套件。

注意:如果您打算使用回傳的承諾,請將exitOnCompletion設定為 false。否則,在承諾解決之前,Node 程序通常會退出。

參數
名稱 類型 屬性 說明
files Array.<string> <optional>

規範檔案執行,而非先前設定的檔案

filterString string <optional>

用於過濾規範的正規表示法。如果已指定,只有完整名稱符合條件的規範能執行。

回傳值

套件完成時已解析的承諾。

類型
Promise.<JasmineDoneInfo>

loadConfig(config)

從指定的物件載入設定檔。

參數
名稱 類型 說明
設定檔 Configuration
繼承自

loadConfigFile(configFilePathopt)

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

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

承諾

provideFallbackReporter(reporter)

如果未指定其他報表員,則提供備用報表員。

參數
名稱 類型 說明
reporter

備用報表員

請參閱

randomizeTests(value)

設定是否將規範順序隨機排序。

參數
名稱 類型 說明
價值 boolean

是否隨機排序

seed(seed)

設定隨機種子。

參數
名稱 類型 說明
seed 數字

隨機種子

showColors(value)

設定是否於主控台報表員顯示顏色。

參數
名稱 類型 說明
價值 boolean

是否顯示顏色

繼承自

stopOnSpecFailure(value)

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

參數
名稱 類型 說明
價值 boolean

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

stopSpecOnExpectationFailure(value)

設定是否讓規範只有一個期望失敗。

參數
名稱 類型 說明
價值 boolean

是否讓規範只有一個期望失敗