クラス: Jasmine

Jasmine(options)

Jasmineテストスイートの設定、構築、実行を行います。

コンストラクタ

new Jasmine(options)

パラメーター
名前 型 説明
options JasmineOptions | undefined
例
const Jasmine = require('jasmine');
const jasmine = new Jasmine();

メンバー

(readonly) env :Env

Jasmine環境。

型
  • Env
参照

exitOnCompletion :boolean

スイートの実行が終了したときにNodeプロセスを終了させるかどうか。

注意: onComplete が呼び出された場合、`exitOnCompletion` が true に設定されていても、スイートが完了したときに Jasmine は終了しません。

型
  • boolean
デフォルト値
  • true

メソッド

addHelperFile(filePath)

スイート実行時にロードされるヘルパーファイルのリストにファイルを追加します。

パラメーター
名前 型 説明
filePath string

ロードするファイルのパス。

addHelperFiles()

Jasmine#addMatchingHelperFilesの同義語

非推奨

addMatchers(matchers)

現在のスコープのスペック用のカスタムマッチャーを追加します。

注意: これは beforeEach, it, または beforeAll 内からのみ呼び出し可能です。

パラメーター
名前 型 説明
matchers Object

このオブジェクトのキーが、新しいマッチャーの名前になります。
参照

addMatchingHelperFiles(patterns)

指定されたパターンに一致するファイルを、ヘルパーファイルのリストに追加します。

パラメーター
名前 型 説明
patterns Array.<string>

ヘルパーファイルのパスまたはglobの配列で、ヘルパーファイルに一致するものです。各パスまたはglobは、スペックディレクトリを基準として評価されます。

addMatchingSpecFiles(patterns)

指定されたパターンに一致するファイルを、スペックファイルのリストに追加します。

パラメーター
名前 型 説明
patterns Array.<string>

スペックファイルのパスまたはglobの配列で、スペックファイルに一致するものです。各パスまたはglobは、スペックディレクトリを基準として評価されます。

addReporter(reporter)

Jasmine環境にカスタムレポーターを追加します。

パラメーター
名前 型 説明
reporter Reporter

追加するレポーター
参照

addSpecFile(filePath)

スイート実行時にロードされるスペックファイルのリストにファイルを追加します。

パラメーター
名前 型 説明
filePath string

ロードするファイルのパス。

addSpecFiles()

Jasmine#addMatchingSpecFilesの同義語

非推奨

clearReporters()

登録されたすべてのレポーターをクリアします。

configureDefaultReporter(options)

他のレポーターが指定されていない場合にインストールされるデフォルトのレポーターを設定します。

パラメーター
名前 型 説明
options ConsoleReporterOptions

coreVersion() → {string}

戻り値

使用中のjasmine-coreのバージョン

型
string

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

テストスイートを実行します。

注意: 返されたPromiseを使用する場合は、exitOnCompletion を false に設定してください。そうしないと、通常、Promise が確定する前に Node プロセスが終了します。

パラメーター
名前 型 属性 説明
files Array.<string> <optional>

以前に設定されたセットの代わりに実行するスペックファイル
filterString string <optional>

スペックをフィルタリングするために使用される正規表現。指定された場合、一致するフルネームを持つスペックのみが実行されます。
戻り値

スイートが完了したときに解決されるPromise。

型
Promise.<JasmineDoneInfo>

loadConfig(config)

指定されたオブジェクトから設定を読み込みます。

パラメーター
名前 型 説明
config Configuration

loadConfigFile(configFilePathopt)

指定されたファイルから設定を読み込みます。ファイルは、JSONファイルまたはrequireを介してロード可能で、デフォルトのエクスポートとしてJasmineの設定を提供する任意のJSファイルです。

パラメーター
名前 型 属性 デフォルト 説明
configFilePath string <optional>
 spec/support/jasmine.json

onComplete(onCompleteCallback)

実行が終了したときに呼び出されるコールバックを登録します。

注意: 登録できるコールバックは1つだけです。コールバックは、スイートが完了し、結果が確定した後、必ずしも Jasmine のクリーンアップがすべて完了する前に呼び出されます。この関数を呼び出すと、Jasmine がスイート実行の最後に Node プロセスを終了するのも防ぎます。

パラメーター
名前 型 説明
onCompleteCallback function
非推奨
  • exitOnCompletion を false に設定し、execute から返された promise を代わりに使用してください。

provideFallbackReporter(reporter)

他のレポーターが指定されていない場合に、フォールバックレポーターを提供します。

パラメーター
名前 型 説明
reporter

フォールバックレポーター
参照

randomizeTests(value)

スペックの順序をランダム化するかどうかを設定します。

パラメーター
名前 型 説明
value boolean

ランダム化するかどうか

seed(seed)

ランダムシードを設定します。

パラメーター
名前 型 説明
seed number

ランダムシード

showColors(value)

コンソールレポーターで色を表示するかどうかを設定します。

パラメーター
名前 型 説明
value boolean

色を表示するかどうか

stopOnSpecFailure(value)

最初のスペックの失敗後にスイートの実行を停止するかどうかを設定します。

パラメーター
名前 型 説明
value boolean

最初のスペックの失敗後にスイートの実行を停止するかどうか

stopSpecOnExpectationFailure(value)

スペックに期待値の失敗を1つだけにするかどうかを設定します。

パラメーター
名前 型 説明
value boolean

スペックに期待値の失敗を1つだけにするかどうか