jasmine 日本語 API リファレンス (jasmine.Matchers)

0 件のコメント

Matchers クラス

マッチャーに関する関数、オブジェクト。

名前空間:jasmine
バージョン:1.2.0

概要
コンストラクタ
<public>
Matchersクラスのインスタンスを初期化します
プロパティ
<private>
env
jasmine.Env インスタンス。
<private>
actual
実際の値。
<private>
spec
jasmine.Spec インスタンス。
<private>
isNot
not 修飾されているかどうか。
<private>
reportWasCalled_ : boolean
メソッド
<private> <static>
<private> <static>
<public>
=== を用いて actual を expected と比較します。
<public>
一般的な等号 を用いて actual を expected と比較します。
<public>
正規表現 を用いて actual を expected と比較します。
<public>
actual を jasmine.undefined と比較します。
<public>
actual を jasmine.undefined と比較します。
<public>
actual を null と比較します。
<public>
boolean の NOT-NOT を実行して返します。
<public>
boolean の NOT を実行して返します。
<public>
actual が 呼び出されたかどうか、Jasmineスパイを参照します。
<public>
actual が パラメタ群とともに呼び出されたかどうか、Jasmineスパイを参照します。
<public>
expected オブジェクトが actual 配列に含まれているかどうかを判定します。
<public>
actual が expected より小さいかどうか判定します。
<public>
actual が expected より大きいかどうか判定します。
<public>
actual が expected と与えられた少数桁数まで一致しているかどうかを調べます。(デフォルトでは少数第2位まで)
<public>
actual によって 例外が発生するかどうか判定します。
クラス
<public>
<public>
詳細
コンストラクタ

Matchers コンストラクタ

Matchers クラスの新しいインスタンスを初期化します。

構文:
function Matchers (
    {jasmine.Env}   env,
    {object}        actual,
    {jasmine.Spec}  spec,
    {boolean}       [opt_isNot]
)
パラメタ:
{jasmine.Env}env
jasmine.Envインスタンス。
{object}actual
実際の値。テスト対象で処理された結果値。toXXX関数ではこの値に対して比較を行う。
{jasmine.Spec}spec
スペック。
{boolean}[opt_isNot]
not 修飾されているかどうか。デフォルトは false。
メソッド

toBe(expected) メソッド

actual と expected が一致するかどうか。=== を用いた比較を行います。

構文:
public {boolean} toBe (
    {object}    expected
)
パラメタ:
{object}expected
期待する値。
戻り値:
{boolean}
actual と expected が一致するかどうか。

toEqual(expected) メソッド

actual と expected が一致するかどうか。Object、Array、Date型など、複雑なオブジェクトの比較で利用します。

構文:
public {boolean} toEqual (
    {object}    expected
)
パラメタ:
{object}expected
期待するオブジェクト。
戻り値:
{boolean}
actual と expected が一致するかどうか。

toMatch(expected) メソッド

正規表現を用いて actual を expected と比較します。actual が expected で規定される正規表現に一致するかどうかを判定します。

構文:
public {boolean} toMatch (
    {string}    expected
)
パラメタ:
{string}expected
正規表現文字列。
戻り値:
{boolean}
actual が expected で規定される正規表現に一致するかどうか。

toBeDefined() メソッド

actual を jasmine.undefined と比較します。

構文:
public {boolean} toBeDefined (
)
パラメタ:
なし。
戻り値:
{boolean}
actual が undefined でないかどうか。

toBeUndefined() メソッド

actual を jasmine.undefined と比較します。actual が undefined かどうかを返します。

構文:
public {boolean} toBeUndefined (
)
パラメタ:
なし。
戻り値:
{boolean}
actual が undefined かどうか。

toBeNull() メソッド

actual を null と比較します。

構文:
public {boolean} toBeNull (
)
パラメタ:
なし。
戻り値:
{boolean}
actual が null かどうか。

toBeTruthy() メソッド

boolean の NOT-NOT を実行して返します。

構文:
public {boolean} toBeTruthy (
)
パラメタ:
なし。
戻り値:
{boolean}
actual が true であるかどうか

toBeFalsy() メソッド

boolean の NOT を実行して返します。

構文:
public {boolean} toBeFlasy (
)
パラメタ:
なし。
戻り値:
{boolean}
actual が false, undefined, null, ""(空文字) かどうか。

toHaveBeenCalled() メソッド

actual が呼び出されたかどうか、Jasmineスパイを参照します。

構文:
public {boolean} toHaveBeenCalled (
)
パラメタ:
なし。
戻り値:
{boolean}
actual が 呼び出されたかどうか。
サンプルコード:
describe("toHaveBeenCalledについて", function() {
    var foo, bar = null;

    beforeEach(function() {
        // テスト用に foo オブジェクトを作成
        foo = {
            setBar: function(value) {
                bar = value;
            }
        };

        // "toHaveBeenCalled"を利用するために Spy を準備
        spyOn(foo, 'setBar');

        // 評価対象となるメソッドを実行
        foo.setBar(123);
    });

    it("foo.setBarが呼び出された", function() {
        expect(foo.setBar).toHaveBeenCalled();    // true が戻る。
    });
}
        

toHaveBeenCalledWidth() メソッド

actual がパラメタ群とともに呼び出されたかどうか、Jasmineスパイを参照します。

構文:
public {boolean} toHaveBeenCalledWidth (
)
パラメタ:
なし。
戻り値:
{boolean}
actual が 呼び出されたかどうか。

toContain(expected) メソッド

expected オブジェクトが actual配列に含まれているかどうか調べます。

構文:
public {boolean} toContain (
    {object}    expected
)
パラメタ:
{object}expected
期待するオブジェクト。
戻り値:
{boolean}
actual配列に expectedオブジェクトが含まれているかどうか。

toBeLessThan(expected) メソッド

actual が expected より小さいかどうか判定します。

構文:
public {boolean} toBeLessThan (
    {number}    expected
)
パラメタ:
{number}expected
期待する上限値。
戻り値:
{boolean}
actual が 指定された値より小さいかどうか。

toBeGreaterThan(expected) メソッド

actual が expected より大きいかどうか判定します。

構文:
public {boolean} toBeGreaterThan (
    {number}    expected
)
パラメタ:
{number}expected
期待する下限値。
戻り値:
{boolean}
actual が 指定された値より大きいかどうか。

toBeCloseTo(expected, [precision]) メソッド

actual が expected で与えられた少数桁数まで一致しているか判定します。

構文:
public {boolean} toBeCloseTo (
    {number}    expected,
    {number}    [precision]
)
パラメタ:
{number}expected
期待する値。
{number}precision
有効桁数。デフォルトは2(少数第2位)。
戻り値:
{boolean}
actual が 指定された有効桁数まで expected と一致しているかどうか。

toThrow([expected]) メソッド

actual が エラーを発生させるかどうか判定します。

構文:
public {boolean} toThrow (
    {string}    [expected]
)
パラメタ:
{string}[expected]
期待されるエラーメッセージ。
戻り値:
{boolean}
actual が 指定されたエラーメッセージのエラーを発生させるかどうか。
サンプルコード:
if("例外を発生する", function () {
    var foo = function () {
        return 1 + 2;
    };
    expect(foo).toThrow();   // このスペックは失敗します。
});