グローバル

メソッド

afterAll(functionopt, timeoutopt)

describe内のすべてのスペックの実行後、一度だけ共有されたティアダウンを実行します。

注記: afterAllからのティアダウンを共有すると、スペック間で誤って状態が漏洩し、誤って合格または不合格になる可能性があるため、注意が必要です。

パラメータ

名前	型	属性	デフォルト	説明
`function`	implementationCallback	<オプション>		スペックをティアダウンするためのコードを含む関数。
`timeout`	Int	<オプション>	`jasmine.DEFAULT_TIMEOUT_INTERVAL`	非同期afterAllのカスタムタイムアウト。

以降

2.1.0

参照

非同期

afterEach(functionopt, timeoutopt)

describe内で呼び出された各スペックの後、共有されたティアダウンを実行します。

パラメータ

名前	型	属性	デフォルト	説明
`function`	implementationCallback	<オプション>		スペックをティアダウンするためのコードを含む関数。
`timeout`	Int	<オプション>	`jasmine.DEFAULT_TIMEOUT_INTERVAL`	非同期afterEachのカスタムタイムアウト。

以降

1.3.0

参照

非同期

beforeAll(functionopt, timeoutopt)

describe内のすべてのスペックの実行前に、一度だけ共有されたセットアップを実行します。

注記: beforeAllからのセットアップを共有すると、スペック間で誤って状態が漏洩し、誤って合格または不合格になる可能性があるため、注意が必要です。

パラメータ

名前	型	属性	デフォルト	説明
`function`	implementationCallback	<オプション>		スペックをセットアップするためのコードを含む関数。
`timeout`	Int	<オプション>	`jasmine.DEFAULT_TIMEOUT_INTERVAL`	非同期beforeAllのカスタムタイムアウト。

以降

2.1.0

参照

非同期

beforeEach(functionopt, timeoutopt)

describe内で呼び出された各スペックの前に、共有されたセットアップを実行します。

パラメータ

名前	型	属性	デフォルト	説明
`function`	implementationCallback	<オプション>		スペックをセットアップするためのコードを含む関数。
`timeout`	Int	<オプション>	`jasmine.DEFAULT_TIMEOUT_INTERVAL`	非同期beforeEachのカスタムタイムアウト。

以降

1.3.0

参照

非同期

describe(description, specDefinitions)

スペックのグループ（多くの場合、スイートと呼ばれます）を作成します。

describeへの呼び出しは、他の呼び出しの中にネストして、スイートをツリーとして構成できます。

パラメータ

名前	型	説明
`description`	文字列	グループのテキスト説明
`specDefinitions`	function	Jasmineが呼び出して内部スイートとスペックを定義する関数

以降

1.3.0

expect(actual) → {matchers}

スペックの期待値を作成します。

パラメータ

名前	型	説明
`actual`	オブジェクト	期待値をテストする実際の計算値。

以降

1.3.0

戻り値

型: matchers

expectAsync(actual) → {async-matchers}

スペックの非同期期待値を作成します。非同期期待値によって提供されるマッチャはすべてPromiseを返し、Jasmineがそれらを正しいスペックに関連付けるために、スペックから返すか、awaitを使用して待機する必要があります。

パラメータ

名前	型	説明
`actual`	オブジェクト	期待値をテストする実際の計算値。

以降

3.3.0

戻り値

型: async-matchers

例

await expectAsync(somePromise).toBeResolved();

return expectAsync(somePromise).toBeResolved();

fail(erroropt)

スペックを明示的に失敗としてマークします。

パラメータ

名前	型	属性	説明
`error`	文字列 \| エラー	<オプション>	失敗の理由。

以降

2.1.0

fdescribe(description, specDefinitions)

フォーカスされたdescribe

スイートまたはスペックがフォーカスされている場合、フォーカスされているものだけが実行されます。

パラメータ

名前	型	説明
`description`	文字列	グループのテキスト説明
`specDefinitions`	function	Jasmineが呼び出して内部スイートとスペックを定義する関数

以降

2.1.0

参照

fit(description, testFunction, timeoutopt)

フォーカスされたit

スイートまたはスペックがフォーカスされている場合、フォーカスされているものだけが実行されます。

パラメータ

名前	型	属性	デフォルト	説明
`description`	文字列			このスペックがチェックしている内容のテキスト説明。
`testFunction`	implementationCallback			テストのコードを含む関数。
`timeout`	Int	<オプション>	`jasmine.DEFAULT_TIMEOUT_INTERVAL`	非同期スペックのカスタムタイムアウト。

以降

2.1.0

参照

非同期

it(description, testFunctionopt, timeoutopt)

単一のスペックを定義します。スペックには、コードの状態をテストする1つ以上の期待値を含める必要があります。

期待値がすべて成功したスペックは合格し、失敗したスペックは失敗します。名前itはテスト対象の代名詞であり、何かの略語ではありません。関数名itと引数descriptionを完全な文として接続することで、スペックの可読性を高めます。

パラメータ

名前	型	属性	デフォルト	説明
`description`	文字列			このスペックがチェックしている内容のテキスト説明
`testFunction`	implementationCallback	<オプション>		テストのコードを含む関数。提供されない場合、テストは`pending`になります。
`timeout`	Int	<オプション>	`jasmine.DEFAULT_TIMEOUT_INTERVAL`	非同期スペックのカスタムタイムアウト。

以降

1.3.0

参照

非同期

pending(messageopt)

スペックを保留中としてマークします。期待値の結果は無視されます。

パラメータ

名前	型	属性	説明
`message`	文字列	<オプション>	スペックが保留中の理由。

以降

2.0.0

setSpecProperty(key, value)

SpecResultのプロパティフィールドの一部としてレポーターに提供されるユーザー定義のプロパティを設定します。

パラメータ

名前	型	説明
`key`	文字列	プロパティの名前
`value`	*	プロパティの値

以降

3.6.0

setSuiteProperty(key, value)

SuiteResultのプロパティフィールドの一部としてレポーターに提供されるユーザー定義のプロパティを設定します。

パラメータ

名前	型	説明
`key`	文字列	プロパティの名前
`value`	*	プロパティの値

以降

3.6.0

spyOn(obj, methodName) → {Spy}

既存のオブジェクトにスパイをインストールします。

パラメータ

名前	型	説明
`obj`	オブジェクト	`Spy`をインストールするオブジェクト。
`methodName`	文字列	`Spy`で置き換えるメソッドの名前。

以降

1.3.0

戻り値

型: Spy

spyOnAllFunctions(obj, includeNonEnumerable) → {Object}

オブジェクトのすべての書き込み可能で構成可能なプロパティにスパイをインストールします。

パラメータ

名前	型	説明
`obj`	オブジェクト	`Spy`をインストールするオブジェクト
`includeNonEnumerable`	ブール値	列挙不可能なプロパティにスパイを追加するかどうか

以降

3.2.1

戻り値

スパイされたオブジェクト

型: オブジェクト

spyOnProperty(obj, propertyName, accessTypeopt) → {Spy}

Object.definePropertyを使用してインストールされたプロパティを既存のオブジェクトにスパイをインストールします。

パラメータ

名前	型	属性	デフォルト	説明
`obj`	オブジェクト			`Spy`をインストールするオブジェクト
`propertyName`	文字列			`Spy`で置き換えるプロパティの名前。
`accessType`	文字列	<オプション>	取得	スパイするプロパティのアクセスタイプ（取得\|設定）。

以降

2.6.0

戻り値

型: Spy

throwUnless(actual, actual) → {matchers}

スペックの期待値を作成し、失敗した場合はエラーをスローします。

これは、testing-libraryのwaitForなどのツールでJasmineマッチャを使用できるようにすることを目的としています。これらのツールは、マッチャの失敗が例外をスローすることを期待し、例外がキャッチされた場合はスペックの失敗をトリガーしません。カスタムマッチャの統合テストにも使用できます。

結果の期待値が失敗した場合、ThrowUnlessFailureがスローされます。例外がコールスタックを介するか、グローバルな未処理例外/未処理Promise拒否イベントを介してJasmineに戻らない限り、失敗した期待値はスペックの失敗にはなりません。

パラメータ

名前	型	説明
`actual`
`actual`	オブジェクト	期待値をテストする実際の計算値。

以降

5.1.0

戻り値

型: matchers

throwUnlessAsync(actual, actual) → {matchers}

スペックの非同期期待値を作成し、失敗した場合はエラーをスローします。

パラメータ

名前	型	説明
`actual`
`actual`	オブジェクト	期待値をテストする実際の計算値。

以降

5.1.0

戻り値

型: matchers

xdescribe(description, specDefinitions)

一時的に無効化されたdescribe

xdescribe内のスペックは保留中としてマークされ、実行されません。

パラメータ

名前	型	説明
`description`	文字列	グループのテキスト説明
`specDefinitions`	function	Jasmineが呼び出して内部スイートとスペックを定義する関数

以降

1.3.0

xit(description, testFunctionopt)

一時的に無効化されたit

スペックはpendingとして報告され、実行されません。

パラメータ

名前	型	属性	説明
`description`	文字列		このスペックがチェックしている内容のテキスト説明。
`testFunction`	implementationCallback	<オプション>	テストのコードを含む関数。実行されません。

以降

1.3.0

型定義

DebugLogEntry

プロパティ

名前	型	説明
`message`	文字列	`jasmine.debugLog`に渡されたメッセージ。
`timestamp`	number	エントリが追加された時間（スペックの開始時間からのミリ秒）

ExpectationResult

期待値の評価結果を説明します。

注：expectedプロパティとactualプロパティは非推奨であり、将来のリリースで削除される可能性があります。多くのJasmine構成では、本質的にロスのあるJSONシリアル化とデシリアル化を通じて渡されます。そのような場合、expected値とactual値は、元のオブジェクトのプレースホルダーまたは近似値になる可能性があります。

プロパティ

名前	型	説明
`matcherName`	文字列	この期待値に対して実行されたマッチャの名前。
`message`	文字列	期待値の失敗メッセージ。
`stack`	文字列	利用可能な場合の失敗のスタックトレース。
`passed`	ブール値	期待値が合格したか不合格だったか。
`期待値`	オブジェクト	非推奨。期待値が不合格だった場合、期待値は何でしたか。
`actual`	オブジェクト	非推奨。期待値が不合格だった場合、実際の値は何でしたか。
`globalErrorType`	文字列 \| 未定義	最上位スイートで報告されるエラーの種類。有効な値は、未定義、"afterAll"、"load"、"lateExpectation"、および "lateError" です。

implementationCallback(doneopt)

Jasmine基本インターフェースの一部に渡されるコールバック。

デフォルトでは、Jasmineはこの関数が同期的に完了すると想定しています。非同期的にテストする必要があるコードがある場合は、doneコールバックを受け取ることを宣言するか、Promiseを返すか、環境でサポートされている場合はasyncキーワードを使用できます。

パラメータ

名前	型	属性	説明
`done`	function	<オプション>	このコールバックが非同期であり、Jasmineは続行する前にコールバックが呼び出されるまで待機する必要があることをJasmineに指定するために使用されます。

戻り値

doneを使用する代わりにPromiseを返すことで、Jasmineが完了を待つようにすることもできます。

JasmineDoneInfo

Reporter#jasmineDone イベントに渡される情報。

プロパティ

名前	型	説明
`overallStatus`	OverallStatus	スイートの全体的な結果："passed"、"failed"、または "incomplete"。
`totalTime`	Int	スイートの実行にかかった合計時間（ms単位）。
`incompleteReason`	文字列	スイートが不完全だった理由に関する、人間が読める説明。
`incompleteCode`	文字列	スイートが不完全だった理由に関する、機械が読める説明："focused"、"noSpecsFound"、または未定義。
`order`	Order	このスイートの実行順序（ランダムかどうか）に関する情報。このプロパティは、Jasmineが並列モードで実行されている場合は存在しません。
`numWorkers`	Int	並列ワーカーの数。このプロパティは、Jasmineが並列モードで実行されている場合のみ存在します。
`failedExpectations`	Array.<ExpectationResult>	グローバルレベルの`afterAll`で失敗した期待値のリスト。
`deprecationWarnings`	Array.<ExpectationResult>	グローバルレベルで発生した非推奨警告のリスト。

以降

2.4.0

JasmineStartedInfo

Reporter#jasmineStarted イベントに渡される情報。

プロパティ

名前	型	説明
`totalSpecsDefined`	Int	このスイートで定義されたスペックの総数。このプロパティは、Jasmineが並列モードで実行されている場合は存在しません。
`order`	Order	このスイートの実行順序（ランダムかどうか）に関する情報。このプロパティは、Jasmineが並列モードで実行されている場合は存在しません。
`parallel`	ブール値	Jasmineが並列モードで実行されているかどうか。

以降

2.0.0

SpecFilter(spec)

スペックを受け取り、実行する必要がある場合はtrue、スキップする必要がある場合はfalseを返す関数。

パラメータ

名前	型	説明
`spec`	Spec	フィルターが適用されるスペック。

戻り値

ブール値

SpecResult

プロパティ

名前	型	説明
`id`	文字列	このスペックの一意のID。
`description`	文字列	このスペックを作成した`it`に渡された説明。
`fullName`	文字列	このスペックのすべての祖先を含む完全な説明。
`parentSuiteId`	文字列 \| null	このスペックを含むスイートのID、またはこのスペックがdescribe()にない場合はnull。
`filename`	文字列	スペックが定義されたファイルの名前。
`failedExpectations`	Array.<ExpectationResult>	このスペックの実行中に失敗した期待値のリスト。
`passedExpectations`	Array.<ExpectationResult>	このスペックの実行中に合格した期待値のリスト。
`deprecationWarnings`	Array.<ExpectationResult>	このスペックの実行中に発生した非推奨警告のリスト。
`pendingReason`	文字列	スペックが`pending`の場合、これが理由になります。
`status`	文字列	スペックが完了すると、この文字列は、このスペックの合格/不合格の状態を表します。
`duration`	number	before/afterEachを含む、スペックの実行に使用された時間（ms単位）。
`properties`	オブジェクト	`Env#setSpecProperty`を使用して設定された、ユーザーが提供したプロパティ（存在する場合）。
`debugLogs`	Array.<DebugLogEntry> \| null	失敗したスペック中に`jasmine.debugLog`を使用してログされたメッセージ（存在する場合）。

以降

2.0.0

SuiteResult

プロパティ

名前	型	説明
`id`	文字列	このスイートの一意のID。
`description`	文字列	このスイートを作成した`describe`に渡された説明テキスト。
`fullName`	文字列	このスイートのすべての祖先を含む完全な説明。
`parentSuiteId`	文字列 \| null	このスイートを含むスイートのID、またはこれが別のdescribe()にない場合はnull。
`filename`	文字列	スイートが定義されたファイルの名前。
`failedExpectations`	Array.<ExpectationResult>	このスイートの`afterAll`で失敗した期待値のリスト。
`deprecationWarnings`	Array.<ExpectationResult>	このスイートで発生した非推奨警告のリスト。
`status`	文字列	スイートが完了すると、この文字列は、このスイートの合格/不合格の状態を表します。
`duration`	number	before/afterAll、before/afterEachを含む、スイートの実行時間（ms単位）。
`properties`	オブジェクト	`Env#setSuiteProperty`を使用して設定された、ユーザーが提供したプロパティ（存在する場合）。

以降

2.0.0