名前空間: matchers

matchers

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()

expectが実際の値(Spy)が呼び出されたことを期待します。

開始
  • 1.3.0
expect(mySpy).toHaveBeenCalled();
expect(mySpy).not.toHaveBeenCalled();

toHaveBeenCalledBefore(expected)

expectが実際の値(Spy)が別のSpyよりも前に呼び出されたことを期待します。

パラメーター
名前 タイプ 説明
expected Spy

actual Spyの後に呼び出されるべきSpy

開始
  • 2.6.0
expect(mySpy).toHaveBeenCalledBefore(otherSpy);

toHaveBeenCalledOnceWith()

expectが実際の値(Spy)が正確に1回呼び出され、特定の引数で正確に呼び出されたことを期待します。

パラメーター
タイプ 属性 説明
オブジェクト <繰り返し可能>

探す引数

開始
  • 3.6.0
expect(mySpy).toHaveBeenCalledOnceWith('foo', 'bar', 2);

toHaveBeenCalledTimes(expected)

expectが実際の値(Spy)が指定された回数呼び出されたことを期待します。

パラメーター
名前 タイプ 説明
expected 数値

探す呼び出し回数。

開始
  • 2.4.0
expect(mySpy).toHaveBeenCalledTimes(3);

toHaveBeenCalledWith()

expectが実際の値(Spy)が少なくとも1回、特定の引数で呼び出されたことを期待します。

パラメーター
タイプ 属性 説明
オブジェクト <繰り返し可能>

探す引数

開始
  • 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が関数がErrorthrowすることを期待します。

パラメーター
名前 タイプ 属性 説明
expected エラー <オプション>

スローされたオブジェクトがインスタンスである必要があるErrorコンストラクター。指定されていない場合は、Errorが使用されます。

メッセージ RegExp | 文字列 <オプション>

スローされたErrorに設定されるべきメッセージ

開始
  • 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');