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

0 件のコメント
Untitled Page

jasmine 名前空間

JavaScript BDD/spec/testing フレームワーク、Jasmine のトップレベル名前空間。

名前空間:_global_
バージョン:1.2.0
概要
名前空間
<namespace>
util
Jasmineで利用する ユーテリティ 関数、クラスを保持します。
<namespace>
Clock
Jasmineで利用するタイマーに関する関数、クラスを保持します。
プロパティ
<private>
undefined : undefined
undefined は他の場所で上書きされている場合があるため、必ずundefined の代わりに jasmine.undefined を利用してください。
<private>
VERBOSE : boolean
このプロパティが true に設定されている場合、診断メッセージをコンソールへ出力します。
<private>
DEFAULT_UPDATE_INTERVAL : number
イベントループを実行するデフォルト インターバル ミリ秒 (ネットワークアクティビティ を許可したり、HTMLベースのランナーをで画面をリフレッシュする場合など)。 小さな値を設定するとテスト実行が遅くなることがあります。 0 は更新されないことを意味します。
<private>
DEFAULT_TIMEOUT_INTERVAL : number
waitsFor() ブロックで、タイムアウト する デフォルトインターバル ミリ秒。
<private>
version_ : object
メソッド
<private>
unimplementedMethod_ : void
<public>
グローバル オブジェクト を取得します。
<public>
指定された遅延の後に、コードの断片または関数を実行します。
<public>
setTimeout によって設定された遅延を解除します。
<public>
一定の遅延間隔を置いて関数を繰り返し呼び出します。
<public>
setInterval によって設定された繰り返し処理を解除します。
<public>
jasmine.Env インスタンス を取得します。
<public>
結果表示用に文字列整形します。
<private>
指定された オブジェクト が配列かどうかを返します。
<private>
指定された オブジェクト が文字列かどうかを返します。
<private>
指定された オブジェクト が数値かどうかを返します。
<private>
指定された オブジェクト が 指定された 型 かどうかを返します。
<public>
引数が DOM要素 の場合、 true を返します。
<public>
マッチ可能なクラス型の "一般"オブジェクト を返します。
<public>
マッチ可能な JSONオブジェクト の サブセット を返します。
<public>
Spy オブジェクト を生成します。
<public>
オブジェクトが jasmine.Spy オブジェクト かどうか判定します。
<public>
より複雑な Spy オブジェクト を生成します。
<public>
全パラメターの文字列整形が終わった後、現在のスペックを書き出します。
クラス
<public>
MessageResult
<public>
ExpectationResult
<public>
XmlHttpRequest
<public>
スタブ、スパイ、フェイク、またはモックとして動作するテストの代役クラス。
<public>
Env
<public>
Reporter
<public>
Block
<public>
JsApiReporter
<public>
マッチャーに関する関数、オブジェクト。
<public>
FakeTimer
<public>
MultiReporter
<public>
NestedResults
<public>
PrettyPrinter
<public>
StringPrettyPrinter
<public>
Queue
<public>
Runner
<public>
Spec
<public>
Suite
<public>
WaitsBlock
<public>
WaitsForBlock
詳細

getGlobal メソッド

グローバル オブジェクト を取得します。

構文:
public {void} getGlobal (
)
パラメタ:
なし。
戻り値:
{object}
グローバル オブジェクト。 window に同じ。

setTimeout メソッド

指定された遅延の後に、コードの断片または関数を実行します。

構文:
public {number} setTimeout (
    {function}  code,
    {number}    delay
)
パラメタ:
{function}code
delay ミリ秒後に実行したい関数。
{number}delay
関数呼び出しを遅延させるミリ秒(1/1000 秒)。実際の呼び出しはこれより長くなる場合がある。
戻り値:
{number}
タイマーを特定する ID。

clearTimeout メソッド

setTimeout によって設定された遅延を解除します。

構文:
public {void} clearTimeout (
        {number}    timerId
)
パラメタ:
{number}timerId
解除したい タイマー ID。
戻り値:
{void}
なし。

setInterval メソッド

一定の遅延間隔を置いて関数を繰り返し呼び出します。

構文:
public {number} setTimeout (
    {function}  code,
    {number}    delay
)
パラメタ:
{function}code
delay ミリ秒間隔で繰り返し実行したい関数。
{number}delay
関数呼び出しを実行させる間隔ミリ秒(1/1000 秒)。
戻り値:
{number}
タイマーを特定する ID。

clearInterval メソッド

setInterval によって設定された繰り返し処理を解除します。

構文:
public {void} clearInterval (
        {number}    timerId
)
パラメタ:
{number}timerId
解除したい タイマー ID。
戻り値:
{void}
なし。

getEnv メソッド

jasmine.Env インスタンス を取得します。

構文:
public {jasmine.Env} getEnv (
)
パラメタ:
なし。
戻り値:
{jasmine.Env}
jasmine.Env インスタンス。

pp メソッド

結果表示用に文字列整形します。
あらゆる オブジェクト を引数にとり、読みやすい文字列に整形して返します。

構文:
public {string} pp (
    {object}    value
)
パラメタ:
{object}value
結果表示用に整形したい オブジェクト。
戻り値:
{string}
整形された文字列。

isArray_ メソッド

指定された オブジェクト が配列かどうかを返します。

構文:
public {boolean} isArray_ (
    {object}    value
)
パラメタ:
{object}value
判定したい オブジェクト。
戻り値:
{boolean}
引数が配列の場合 true、それ以外の場合 false。

isString_ メソッド

指定された オブジェクト が文字列かどうかを返します。

構文:
public {boolean} isString_ (
    {object}    value
)
パラメタ:
{object}value
判定したい オブジェクト。
戻り値:
{boolean}
引数が文字列の場合 true、それ以外の場合 false。

isNumber_ メソッド

指定された オブジェクト が数値かどうかを返します。

構文:
public {boolean} isNumber_ (
    {object}    value
)
パラメタ:
{object}value
判定したい オブジェクト。
戻り値:
{boolean}
引数が数値の場合 true、それ以外の場合 false。

isA_ メソッド

指定された オブジェクト が 指定された 型 かどうかを返します。

構文:
public {boolean} isA_ (
    {string}    typeName,
    {object}    value
)
パラメタ:
{string}typeName
判定したい型名称。
{object}value
判定したい オブジェクト。
戻り値:
{boolean}
引数が指定された型の場合 true、それ以外の場合 false。

isDomNode メソッド

引数が DOM要素 の場合、 true を返します。

構文:
public {bolean} isDomNode (
    {object}    obj
)
パラメタ:
{object}obj
DOM要素かどうか調べたい オブジェクト。
戻り値:
{boolean}
DOM要素かどうか。

any メソッド

マッチ可能なクラス型の "一般"オブジェクト を返します。 値を気にしない型の判定で使います。

構文:
public {jasmine.Matchers.Any} any (
    {function}  clazz
)
パラメタ:
{function}clazz
クラス オブジェクト。
戻り値:
{jasmine.Matchers.Any}
マッチ可能な jasmine.Matchers.Any オブジェクト。
サンプルコード:
// 関数が呼び出されたことだけを調査し、その他は無視します。
expect(mySpy).toHaveBeenCalledWith(jasmine.any(Function));

objectContaining メソッド

マッチ可能な JSONオブジェクト の サブセット を返します。 オブジェクトの全属性を気にしない判定で使います。

構文:
public {jasmine.Matchers.ObjectContaining} objectContaining (
    {object}    sample
)
パラメタ:
{object}sample
サンプル オブジェクト。
戻り値:
{jasmine.Matchers.Any}
マッチ可能な jasmine.Matchers.ObjectContaining オブジェクト。
サンプルコード:
// オブジェクト プロパティ "foo" のみを調べて、他は無視します。
expect(mySpy).toHaveBeenCalledWith(jasmine.objectContaining({foo: "bar"});

createSpy メソッド

Spy オブジェクト を生成します。

構文:
public {jasmine.Sply} createSpy (
        {string}    name
)
パラメタ:
{string}name
Spy オブジェクト の名称。
戻り値:
{jasmine.Spy}
jasmine.Spy オブジェクト インスタンス。

isSpy メソッド

オブジェクトが jasmine.Spy オブジェクト かどうか判定します。

構文:
public {boolean} isSpy (
    {object}    putativeSpy
)
パラメタ:
{object}putativeSpy
判定したい オブジェクト。
戻り値:
{boolean}
jasmine.Spy オブジェクト の場合 true、その他の場合 false。

createSpyObj メソッド

より複雑な Spy オブジェクト を生成します。 すべての プロパティ が Spyオブジェクト で成り立つ オブジェクト を生成します。
大きな スタブ を生成したい場合に利用します。
baseName + methodName の Spy オブジェクト を大量生成します。

構文:
public {object} createSpyObj (
        {string}    baseName,
        {string[]}  methodNames
)
パラメタ:
{string}baseName
Spyオブジェクト の基本名。
{string[]}methodNames
Spyオブジェクト を生成したい関数名の配列。
戻り値:
{object}
すべての プロパティ が Spyオブジェクト で成り立つ オブジェクト

log メソッド

全パラメターの文字列整形が終わった後、現在のスペックを書き出します。
jasmine.log は製品コード中で利用しないでください。

構文:
public {void} log (
)
パラメタ:
なし。
戻り値:
{void}
なし。