Jasmineに最初から付属しているマッチャー。
メンバー
not :matchers
このexpectation
に続くマッチャーを反転します
タイプ
- 開始
- 1.3.0
例
expect(something).not.toBe(true);
メソッド
nothing()
expect
が何も明示的に期待しないようにします。
- 開始
- 2.8.0
例
expect().nothing();
toBe(expected)
expect
が実際の値が期待値と===
になることを期待します。
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
オブジェクト | 比較対象となる期待値。 |
- 開始
- 1.3.0
例
expect(thing).toBe(realThing);
toBeCloseTo(expected, precisionopt)
expect
が実際の値が指定された精度内で期待値になることを期待します。
パラメーター
名前 | タイプ | 属性 | デフォルト | 説明 |
---|---|---|---|---|
expected |
オブジェクト | 比較対象となる期待値。 |
||
precision |
数値 | <オプション> |
2 | チェックする小数点以下の桁数。 |
- 開始
- 1.3.0
例
expect(number).toBeCloseTo(42.2, 3);
toBeDefined()
expect
が実際の値が定義されていることを期待します。(undefined
ではない)
- 開始
- 1.3.0
例
expect(result).toBeDefined();
toBeFalse()
expect
が実際の値がfalse
であることを期待します。
- 開始
- 3.5.0
例
expect(result).toBeFalse();
toBeFalsy()
expect
が実際の値が偽であることを期待します
- 開始
- 2.0.0
例
expect(result).toBeFalsy();
toBeGreaterThan(expected)
expect
が実際の値が期待値より大きいことを期待します。
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
数値 | 比較対象となる値。 |
- 開始
- 2.0.0
例
expect(result).toBeGreaterThan(3);
toBeGreaterThanOrEqual(expected)
expect
が実際の値が期待値以上であることを期待します。
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
数値 | 比較対象となる期待値。 |
- 開始
- 2.0.0
例
expect(result).toBeGreaterThanOrEqual(25);
toBeInstanceOf(expected)
expect
が実際の値が期待されるクラスのインスタンスであることを期待します
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
オブジェクト | チェックするクラスまたはコンストラクター関数 |
- 開始
- 3.5.0
例
expect('foo').toBeInstanceOf(String);
expect(3).toBeInstanceOf(Number);
expect(new Error()).toBeInstanceOf(Error);
toBeLessThan(expected)
expect
が実際の値が期待値より小さいことを期待します。
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
数値 | 比較対象となる期待値。 |
- 開始
- 2.0.0
例
expect(result).toBeLessThan(0);
toBeLessThanOrEqual(expected)
expect
が実際の値が期待値以下であることを期待します。
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
数値 | 比較対象となる期待値。 |
- 開始
- 2.0.0
例
expect(result).toBeLessThanOrEqual(123);
toBeNaN()
expect
が実際の値がNaN
(非数値)であることを期待します。
- 開始
- 1.3.0
例
expect(thing).toBeNaN();
toBeNegativeInfinity()
expect
が実際の値が-Infinity
(マイナス無限大)であることを期待します。
- 開始
- 2.6.0
例
expect(thing).toBeNegativeInfinity();
toBeNull()
expect
が実際の値がnull
であることを期待します。
- 開始
- 1.3.0
例
expect(result).toBeNull();
toBePositiveInfinity()
expect
が実際の値がInfinity
(無限大)であることを期待します。
- 開始
- 2.6.0
例
expect(thing).toBePositiveInfinity();
toBeTrue()
expect
が実際の値がtrue
であることを期待します。
- 開始
- 3.5.0
例
expect(result).toBeTrue();
toBeTruthy()
expect
が実際の値が真であることを期待します。
- 開始
- 2.0.0
例
expect(thing).toBeTruthy();
toBeUndefined()
expect
が実際の値がundefined
であることを期待します。
- 開始
- 1.3.0
例
expect(result).toBeUndefined():
toContain(expected)
expect
が実際の値が特定の値を含むことを期待します。
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
オブジェクト | 探す値。 |
- 開始
- 2.0.0
例
expect(array).toContain(anElement);
expect(string).toContain(substring);
toEqual(expected)
expect
が実際の値が、深い等価性比較を使用して、期待値に等しいことを期待します。
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
オブジェクト | 期待値 |
- 開始
- 1.3.0
例
expect(bigObject).toEqual({"foo": ['bar', 'baz']});
toHaveBeenCalled()
- 開始
- 1.3.0
例
expect(mySpy).toHaveBeenCalled();
expect(mySpy).not.toHaveBeenCalled();
toHaveBeenCalledBefore(expected)
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
Spy |
- 開始
- 2.6.0
例
expect(mySpy).toHaveBeenCalledBefore(otherSpy);
toHaveBeenCalledOnceWith()
パラメーター
タイプ | 属性 | 説明 |
---|---|---|
オブジェクト | <繰り返し可能> |
探す引数 |
- 開始
- 3.6.0
例
expect(mySpy).toHaveBeenCalledOnceWith('foo', 'bar', 2);
toHaveBeenCalledTimes(expected)
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
数値 | 探す呼び出し回数。 |
- 開始
- 2.4.0
例
expect(mySpy).toHaveBeenCalledTimes(3);
toHaveBeenCalledWith()
パラメーター
タイプ | 属性 | 説明 |
---|---|---|
オブジェクト | <繰り返し可能> |
探す引数 |
- 開始
- 1.3.0
例
expect(mySpy).toHaveBeenCalledWith('foo', 'bar', 2);
toHaveClass(expected)
expect
が実際の値が期待されるクラスを持つDOM要素であることを期待します
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
オブジェクト | テストするクラス名 |
- 開始
- 3.0.0
例
const el = document.createElement('div');
el.className = 'foo bar baz';
expect(el).toHaveClass('bar');
toHaveSize(expected)
expect
が実際のサイズが、配列のような長さまたはオブジェクトキーのサイズを使用して、期待値に等しいことを期待します。
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
オブジェクト | 期待されるサイズ |
- 開始
- 3.6.0
例
array = [1,2];
expect(array).toHaveSize(2);
toHaveSpyInteractions()
expect
が実際の値(SpyObj
)のスパイが呼び出されたことを期待します。
- 開始
- 4.1.0
例
expect(mySpyObj).toHaveSpyInteractions();
expect(mySpyObj).not.toHaveSpyInteractions();
toMatch(expected)
expect
が実際の値が正規表現に一致することを期待します
パラメーター
名前 | タイプ | 説明 |
---|---|---|
expected |
RegExp | 文字列 | 文字列内で検索する値。 |
- 開始
- 1.3.0
例
expect("my string").toMatch(/string$/);
expect("other string").toMatch("her");
toThrow(expectedopt)
expect
が関数が何かをthrow
することを期待します。
パラメーター
名前 | タイプ | 属性 | 説明 |
---|---|---|---|
expected |
オブジェクト | <オプション> |
スローされるべき値。指定されていない場合は、何かがスローされたという事実のみがチェックされます。 |
- 開始
- 2.0.0
例
expect(function() { return 'things'; }).toThrow('foo');
expect(function() { return 'stuff'; }).toThrow();
toThrowError(expectedopt, messageopt)
expect
が関数がError
をthrow
することを期待します。
パラメーター
名前 | タイプ | 属性 | 説明 |
---|---|---|---|
expected |
エラー | <オプション> |
スローされたオブジェクトがインスタンスである必要がある |
メッセージ |
RegExp | 文字列 | <オプション> |
スローされた |
- 開始
- 2.0.0
例
expect(function() { return 'things'; }).toThrowError(MyCustomError, 'message');
expect(function() { return 'things'; }).toThrowError(MyCustomError, /bar/);
expect(function() { return 'stuff'; }).toThrowError(MyCustomError);
expect(function() { return 'other'; }).toThrowError(/foo/);
expect(function() { return 'other'; }).toThrowError();
toThrowMatching(predicate)
expect
が関数が述語に一致する何かをthrow
することを期待します。
パラメーター
名前 | タイプ | 説明 |
---|---|---|
述語 |
関数 | スローされた例外をパラメーターとして受け取り、一致する場合はtrueを返す関数。 |
- 開始
- 3.0.0
例
expect(function() { throw new Error('nope'); }).toThrowMatching(function(thrown) { return thrown.message === 'nope'; });
withContext(message) → {matchers}
expectation
のマッチャーの失敗に含まれるコンテキストを追加して、同様の期待値からより簡単に区別できるようにします。
パラメーター
名前 | タイプ | 説明 |
---|---|---|
メッセージ |
文字列 | マッチャーが失敗したときに表示する追加のコンテキスト |
- 開始
- 3.3.0
戻り値
- タイプ
- matchers
例
expect(things[0]).withContext('thing 0').toEqual('a');
expect(things[1]).withContext('thing 1').toEqual('b');