基本的にjasmineのソースコードにあるjsdocコメントを日本語化しています。 補足 or 修正している個所もあります。 日本語が変だったり、補足が変だったりと、不備があるかもしれないので、そういった場合は指摘いただけると幸いです。
_global_ 名前空間
_global_ な空間(windowオブジェクトへ直接ぶら下がる)に定義された名前空間、関数。
<namespace> |
Jasmineで利用する関数、クラスを保持します。
|
---|
<public> |
スイート内の各スペック実行後に呼び出される関数。
|
---|---|
<public> |
スイート内の各スペック実行前に呼び出される関数。
|
<public> |
スペックスイートを定義します。
|
<public> |
期待値を求めるためのメソッドチェーンを開始します。
|
<public> |
現在のスイートへ追加するスペックを生成します。
|
<public> |
jasmineスペックの一部を定義します。
|
<public> |
既に存在するオブジェクトのメソッドに対してスパイを組み込みます。
|
<public> |
次のブロックへ移る前に指定された時間待ちます。
|
<public> |
次のブロックへ移る前、latchFunction が true を返すまで待ちます。
|
<public> |
スペックスイートを無効にします。
|
<public> |
無効なjasmineスペックを生成します。
|
afterEach メソッド
スイート内の各スペック実行後に呼び出される関数。
スペック実行中に上書きした状態の復元に使います。
public {void} afterEach ( {function} afterEachFunction )
- {function}afterEachFunction
- 各スペック実行後に行う復元処理。
- {void}
- なし。
beforeEach メソッド
スイート内の各スペック実行前に呼び出される関数。
スペック実行の準備、前提条件の検証に使います。
public {void} beforeEach ( {function} beforeEachFunction )
- {function}beforeEachFunction
- 各スペック実行前に行う準備および検証処理。
- {void}
- なし。
describe メソッド
スペックスイートを定義します。
Jasmine環境に"description"と"スペック"を1つのスイートとして保存します。 この関数中で定義される変数は、関数中で呼ばれる"beforeEach",
"it", "afterEach"においてアクセスできます。 "describe"ブロックは入れ子で定義できます。 これにより、いくつかのテストにおいて特別なセットアップを行うことができます。
public {jasmine.Suite} describe ( {string} description, {function} specDefinitions )
- {string}description
- 文字列。通常はテスト対象となるクラス名。
- {function}specDefinitions
- スペックを定義する関数。
- {jasmine.Suite}
- jasmineスイートの内部表現。
expect メソッド
期待値を求めるためのメソッドチェーンを開始します。
引数として渡された Object は実際の値であり、jasmine.Matchers関数のいずれかにチェーンします。
public {jasmine.Matchers} expect ( {object} actual )
- {object}actual
- 期待値に対してテストしたい実際の値
- {jasmine.Matchers}
- マッチャー。
it メソッド
現在のスイートへ追加するスペックを生成します。
public {jasmine.Spec} it ( {string} desc, {function} func )
- {string}desc
- スペックの説明。
- {function}func
- スペックの前提条件と期待値を定義します。
- {jasmine.Spec}
- jasmineスペックの内部表現。
1 2 3 | it( 'should be true' , function () { expect( true ).toEqual( true ); }); |
runs メソッド
jasmineスペックの一部を定義します。
非同期スペックにおいて、waitsまたはwaitsForと組み合わせて利用します。
public {void} runs ( {function} func )
- {function}func
- jasmineスペックの一部分を定義する関数。
- {void}
- なし。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | it( "should support async execution of test preparation and exepectations" , function () { runs( function () { flag = false ; value = 0; setTimeout( function () { flag = true ; }, 500); }); waitsFor( function () { value++; return flag; }, "The Value should be incremented" , 750); runs( function () { expect(value).toBeGreaterThan(0); }); }); |
spyOnメソッド
既に存在するオブジェクトのメソッドに対してスパイを組み込みます。
スペック中でスパイを生成するために使います。
public {object} spyOn ( {object} obj, {string} methodName )
- {object}obj
- 監視したい関数を持つインスタンスオブジェクト。
- {string}methodName
- 監視したい関数名。
- {object}
- すべてのスパイ関数が実行できるjasmineスパイオブジェクト。(引数で与えた obj に対して スパイ として拡張を行ったオブジェクト。)
waits メソッド
次のブロックへ移る前に指定された時間待ちます。
public {void} waits ( {number} timeout )
- {number}timeout
- 待つ時間。単位はミリ秒。
- {void}
- なし。
waitsForメソッド
次のブロックへ移る前、latchFunction が true を返すまで待ちます。
public {void} waitsFor ( {function} latchFunction, {string} [optional_timeoutMessage], {number} [optional_timeout] )
- {function}latchFunction
- 待機する条件。この関数が true を返すまで waitsFor 関数は待機します。
- {string}[optional_timeoutMessage]
- タイムアウト時(失敗時)のメッセージ。
- {number}[optional_timeout]
- latchFunction を監視する時間。単位はミリ秒。
- {void}
- なし。
xdescribe メソッド
スペックスイートを無効にします。
開発中、失敗するスイートを一時的に無効にするために使います。
public {object} xdescribe ( {string} description, {function} specDefinitions )
- {string}description
- 文字列。通常はテスト対象となるクラス名。
- {function}specDefinitions
- スペックを定義する関数。
- {object}
- jasmine.Suiteを模した空のオブジェクト。
xit メソッド
無効なjasmineスペックを生成します。
開発中、一時的にスペックを無効にする便利な関数です。
public {object} xit ( {string} desc, {function} func )
- {string}desc
- スペックの説明。
- {function}func
- スペックの前提条件と期待値を定義します。
- {object}
- jasmine.Specを模した空のオブジェクト。
最後に… このブログに興味を持っていただけた方は、 ぜひ 「Facebookページ に いいね!」または 「Twitter の フォロー」 お願いします!!