Mocha - ドキュメント

new Mocha(optionsopt)

ソース

mocha.js, 146行目

optionsを使用して新しいMochaインスタンスを構築します。

Parameters

名前タイプ属性説明

options

オブジェクト

<オプション>

設定オブジェクト。

プロパティ

名前	タイプ	属性	説明
`allowUncaught`	真偽値	<オプション>	キャッチされないエラーを伝播しますか？
`asyncOnly`	真偽値	<オプション>	`done`コールバックまたはpromiseを強制しますか？
`bail`	真偽値	<オプション>	最初のテスト失敗後に中断しますか？
`checkLeaks`	真偽値	<オプション>	グローバル変数リークをチェックしますか？
`color`	真偽値	<オプション>	レポーターからのTTYカラー出力を有効にしますか？
`delay`	真偽値	<オプション>	ルートスイートの実行を遅延しますか？
`diff`	真偽値	<オプション>	失敗時に差分を表示しますか？
`dryRun`	真偽値	<オプション>	テストを実行せずにレポートしますか？
`failZero`	真偽値	<オプション>	テストがゼロの場合、テスト実行を失敗させますか？
`fgrep`	文字列	<オプション>	指定された文字列でテストをフィルタリングします。
`forbidOnly`	真偽値	<オプション>	`only`とマークされたテストはスイートを失敗させますか？
`forbidPending`	真偽値	<オプション>	保留中のテストはスイートを失敗させますか？
`fullTrace`	真偽値	<オプション>	失敗時に完全なスタックトレースを出力しますか？
`global`	配列:.<文字列:>	<オプション>	グローバルスコープで予期される変数。
`grep`	RegExp \| 文字列	<オプション>	指定された正規表現でテストをフィルタリングします。
`inlineDiffs`	真偽値	<オプション>	インライン差分を表示しますか？
`invert`	真偽値	<オプション>	テストフィルターの一致を反転しますか？
`noHighlighting`	真偽値	<オプション>	構文ハイライトを無効にしますか？
`reporter`	文字列 \| コンストラクタ	<オプション>	レポーター名またはコンストラクタ。
`reporterOption`	オブジェクト	<オプション>	レポーター設定オブジェクト。
`retries`	数値	<オプション>	失敗したテストを再試行する回数。
`slow`	数値	<オプション>	スロー閾値。
`timeout`	数値 \| 文字列	<オプション>	タイムアウト閾値。
`ui`	文字列	<オプション>	インターフェース名。
`parallel`	真偽値	<オプション>	ジョブを並列で実行します。
`jobs`	数値	<オプション>	並列実行用の最大ワーカプロセス数。
`rootHooks`	MochaRootHookObject	<オプション>	ルートスイートをブートストラップするためのフック。
`require`	配列:.<文字列:>	<オプション>	並列実行用の`rootHooks`プラグインのパス名。
`isWorker`	真偽値	<オプション>	`Mocha`プロセスがワーカプロセスで実行されている場合は、`true`である必要があります。

メンバー

(static) exports.reporters

ソース

mocha.js, 79行目

(static) exports.Runner

ソース

mocha.js, 86行目

(readonly) version :文字列

ソース

mocha.js, 924行目

"package.json"で指定されたMochaバージョン。

タイプ

文字列

メソッド

addFile(file) → {Mocha}

実行のために読み込むfileを追加します。

ソース

mocha.js, 301行目

参照

CLIオプション

テストスイートに含める必要のある一般的な設定コードに役立ちます。

Parameters

名前	タイプ	説明
`file`	文字列	読み込むファイルのパス名。

戻り値

this

タイプ: Mocha

allowUncaught(allowUncaughtopt) → {Mocha}

ソース

mocha.js, 823行目

参照

CLIオプション

キャッチされないエラーの伝播を有効または無効にします。

Parameters

名前	タイプ	属性	デフォルト	説明
`allowUncaught`	真偽値	<オプション>	`true`	キャッチされないエラーを伝播するかどうか。

戻り値

this

タイプ: Mocha

asyncOnly(asyncOnlyopt) → {Mocha}

ソース

mocha.js, 797行目

参照

CLIオプション

すべてのテストで、doneコールバックを受け入れるか、promiseを返すことを強制します。

Parameters

名前	タイプ	属性	デフォルト	説明
`asyncOnly`	真偽値	<オプション>	`true`	`done`コールバックまたはpromiseを強制するかどうか。

戻り値

this

タイプ: Mocha

bail(bailopt) → {Mocha}

ソース

mocha.js, 283行目

参照

CLIオプション

最初の失敗で中断することを有効または無効にします。

Parameters

名前	タイプ	属性	デフォルト	説明
`bail`	真偽値	<オプション>	`true`	最初のエラーで中断するかどうか。

戻り値

this

タイプ: Mocha

checkLeaks(checkLeaksopt) → {Mocha}

ソース

mocha.js, 599行目

参照

CLIオプション

テストの実行中にリークしたグローバル変数のチェックを有効または無効にします。

Parameters

名前	タイプ	属性	デフォルト	説明
`checkLeaks`	真偽値	<オプション>	`true`	グローバル変数リークをチェックするかどうか。

戻り値

this

タイプ: Mocha

cleanReferencesAfterRun(cleanReferencesAfterRun) → {Mocha}

ソース

mocha.js, 614行目

参照

Mocha#dispose

各テスト実行後に破棄するかどうかを有効または無効にします。
テストスイートを複数回実行できるようにするには、これを無効にしてください。
無効にした場合は、メモリリークを防ぐために完了したらmochaを破棄してください。

Parameters

名前	タイプ	説明
`cleanReferencesAfterRun`	真偽値

戻り値

this

タイプ: Mocha

color(coloropt) → {Mocha}

ソース

mocha.js, 685行目

参照

CLIオプション

画面指向のレポーターによるTTYカラー出力を有効または無効にします。

Parameters

名前	タイプ	属性	デフォルト	説明
`color`	真偽値	<オプション>	`true`	カラー出力を有効にするかどうか。

戻り値

this

タイプ: Mocha

delay() → {Mocha}

ルートスイートの実行を遅延します。

ソース

mocha.js, 840行目

参照

遅延ルートスイート

スイートを実行する前に非同期操作を実行するために使用されます。

戻り値

this

タイプ: Mocha

diff(diffopt) → {Mocha}

ソース

mocha.js, 714行目

参照

CLIオプション

テスト失敗出力に差分を含めるようにレポーターを有効または無効にします。

Parameters

名前	タイプ	属性	デフォルト	説明
`diff`	真偽値	<オプション>	`true`	失敗時に差分を表示するかどうか。

戻り値

this

タイプ: Mocha

dispose()

ソース

mocha.js, 624行目

このmochaインスタンスを手動で破棄します。このインスタンスをdisposedとマークし、さらにテストを実行できないようにします。
また、テスト関数とフックへの関数参照を削除するため、クロージャにトラップされた変数はガベージコレクタによってクリーンアップできます。

dryRun(dryRunopt) → {Mocha}

ソース

mocha.js, 854行目

参照

CLIオプション

テストをドライランモードで実行するかどうかを有効または無効にします。

Parameters

名前	タイプ	属性	デフォルト	説明
`dryRun`	真偽値	<オプション>	`true`	ドライランモードをアクティブにするかどうか。

戻り値

this

タイプ: Mocha

enableGlobalSetup(enabledopt) → {Mocha}

ソース

mocha.js, 1230行目

グローバル設定フィクスチャの実行を切り替えます

Parameters

名前	タイプ	属性	デフォルト	説明
`enabled`	真偽値	<オプション>	`true`	`false`の場合、グローバル設定フィクスチャを実行しません

戻り値

タイプ: Mocha

enableGlobalTeardown(enabledopt) → {Mocha}

ソース

mocha.js, 1243行目

グローバルティアダウンフィクスチャの実行を切り替えます

Parameters

名前	タイプ	属性	デフォルト	説明
`enabled`	真偽値	<オプション>	`true`	`false`の場合、グローバルティアダウンフィクスチャを実行しません

戻り値

タイプ: Mocha

failZero(failZeroopt) → {Mocha}

ソース

mocha.js, 868行目

参照

CLIオプション

テストが1つも検出されない場合、終了コード1でテスト実行を失敗させます。

Parameters

名前	タイプ	属性	デフォルト	説明
`failZero`	真偽値	<オプション>	`true`	テスト実行を失敗させるかどうか。

戻り値

this

タイプ: Mocha

fgrep(str) → {Mocha}

ソース

mocha.js, 521行目

参照

Mocha#grep

RegExp特殊文字をエスケープした後、grepフィルターを設定します。

例

// Select tests whose full title begins with `"foo"` followed by a period
mocha.fgrep('foo.');

Parameters

名前	タイプ	説明
`str`	文字列	正規表現に変換される値。

戻り値

this

タイプ: Mocha

forbidOnly(forbidOnlyopt) → {Mocha}

ソース

mocha.js, 882行目

参照

CLIオプション

only とマークされたテストをスイートで失敗させます。

Parameters

名前	タイプ	属性	デフォルト	説明
`forbidOnly`	真偽値	<オプション>	`true`	`only` とマークされたテストがスイートを失敗させるかどうか。

戻り値

this

タイプ: Mocha

forbidPending(forbidPendingopt) → {Mocha}

ソース

mocha.js, 896行目

参照

CLIオプション

保留中のテストと skip とマークされたテストをスイートで失敗させます。

Parameters

名前	タイプ	属性	デフォルト	説明
`forbidPending`	真偽値	<オプション>	`true`	保留中のテストがスイートを失敗させるかどうか。

戻り値

this

タイプ: Mocha

fullTrace(fullTraceopt) → {Mocha}

ソース

mocha.js, 645行目

参照

CLIオプション

テスト失敗時にフルスタックトレースを表示します。

Parameters

名前	タイプ	属性	デフォルト	説明
`fullTrace`	真偽値	<オプション>	`true`	失敗時にフルスタックトレースを印刷するかどうか。

戻り値

this

タイプ: Mocha

global(global) → {Mocha}

ソース

mocha.js, 664行目

参照

グローバルスコープで予期される変数名のホワイトリストを指定します。

例

// Specify variables to be expected in global scope
mocha.global(['jQuery', 'MyLib']);

Parameters

名前	タイプ	説明
`global`	配列:.<文字列:> \| 文字列	受け入れられるグローバル変数名（複数可）。

戻り値

this

タイプ: Mocha

globalSetup(setupFnsopt) → {Mocha}

ソース

mocha.js, 1140行目

1つ以上のグローバルセットアップフィクスチャを設定します。

パラメーターが与えられない場合、以前に設定されたフィクスチャを設定解除します。

Parameters

名前	タイプ	属性	説明
`setupFns`	MochaGlobalFixture \| 配列:.<MochaGlobalFixture:>	<オプション>	グローバルセットアップフィクスチャ（複数可）

戻り値

タイプ: Mocha

globalTeardown(teardownFnsopt) → {Mocha}

ソース

mocha.js, 1156行目

1つ以上のグローバルティアダウンフィクスチャを設定します。

パラメーターが与えられない場合、以前に設定されたフィクスチャを設定解除します。

Parameters

名前	タイプ	属性	説明
`teardownFns`	MochaGlobalFixture \| 配列:.<MochaGlobalFixture:>	<オプション>	グローバルティアダウンフィクスチャ（複数可）

戻り値

タイプ: Mocha

grep(re) → {Mocha}

実行する特定のテストを選択するために使用される grep フィルターを設定します。

ソース

mocha.js, 562行目

参照

re が正規表現のような文字列の場合、正規表現に変換されます。
正規表現は、各テストの完全なタイトル（つまり、
テストの名前の前に、先祖スイートのタイトルが付きます）に対してテストされます。
そのため、テスト名自体に対して完全一致の固定パターンを使用しても、
一致するものは何も生成されません。

以前のフィルター値は、呼び出しごとに上書きされます！

例

// Select tests whose full title contains `"match"`, ignoring case
mocha.grep(/match/i);

// Same as above but with regexp-like string argument
mocha.grep('/match/i');

// ## Anti-example
// Given embedded test `it('only-this-test')`...
mocha.grep('/^only-this-test$/');    // NO! Use `.only()` to do this!

Parameters

名前	タイプ	説明
`re`	RegExp \| 文字列	テストを選択するために使用される正規表現。

戻り値

this

タイプ: Mocha

hasGlobalSetupFixtures() → {boolean}

ソース

mocha.js, 1255行目

1つ以上のグローバルセットアップフィクスチャが提供されている場合は true を返します。

戻り値

タイプ: 真偽値

hasGlobalTeardownFixtures() → {boolean}

ソース

mocha.js, 1264行目

1つ以上のグローバルティアダウンフィクスチャが提供されている場合は true を返します。

戻り値

タイプ: 真偽値

inlineDiffs(inlineDiffsopt) → {Mocha}

ソース

mocha.js, 700行目

参照

CLIオプション

テスト失敗出力でインライン差分（+/- ではなく）を使用するようにレポーターを有効または無効にします。
インライン差分を使用するかどうか。

Parameters

名前	タイプ	属性	デフォルト	説明
`inlineDiffs`	真偽値	<オプション>	`true`	インライン差分を使用するかどうか。

戻り値

this

タイプ: Mocha

invert() → {Mocha}

ソース

mocha.js, 585行目

参照

Mocha#grep

grep の一致を反転します。

例

// Select tests whose full title does *not* contain `"match"`, ignoring case
mocha.grep(/match/i).invert();

戻り値

this

タイプ: Mocha

lazyLoadFiles(enableopt)

ソース

mocha.js, 1125行目

To Do

すでにファイルをロードしている場合、これは例外をスローする必要があります。このような動作には、新しい状態を追加する必要があります。

Mocha#run での Mocha#loadFiles の暗黙的な呼び出しを無効にします。この
設定は、ウォッチモード、並列モード、および ESM ファイルの読み込みに使用されます。

Parameters

名前	タイプ	属性	説明
`enable`	真偽値	<オプション>	`true` の場合、ファイルのエグレスロードを無効にします Mocha#run

loadFilesAsync(optionsopt) → {Promise}

ソース

mocha.js, 442行目

参照

実装は、テストインターフェイス関数を実行するために Node の require および import に依存しており、そのキャッシュの対象となります。
CJS モジュールと ESM モジュールの両方をサポートします。
CJS モジュールと ESM モジュールの両方をサポートします。

例

// loads ESM (and CJS) test files asynchronously, then runs root suite
mocha.loadFilesAsync()
  .then(() => mocha.run(failures => process.exitCode = failures ? 1 : 0))
  .catch(() => process.exitCode = 1);

Parameters

名前タイプ属性説明

options

オブジェクト

<オプション>

設定オブジェクト。

プロパティ

名前	タイプ	属性	説明
`esmDecorator`	function	<オプション>	esm モジュール名をインポートする直前に呼び出される関数。デフォルトではそのままパススルーします。

戻り値

タイプ: Promise

noHighlighting() → {Mocha}

ソース

mocha.js, 809行目

(ブラウザーで)構文の強調表示を無効にします。

戻り値

this

タイプ: Mocha

parallelMode(enableopt) → {Mocha}

ソース

mocha.js, 1086行目

並列モードを切り替えます。

Mocha#run を呼び出す前に実行する必要があります。Runner クラスを
使用するように変更します。また、まだ実行されていない場合は、遅延ファイル読み込みを有効にします。

警告: false が渡され、遅延読み込みが何らかの方法（parallelMode(true) の呼び出しを含む）で有効になっている場合、このメソッドは遅延読み込みを無効にしません。遅延読み込みは並列処理の前提条件ですが、
並列モードは遅延読み込みの前提条件ではありません。

Parameters

名前	タイプ	属性	説明
`enable`	真偽値	<オプション>	`true` の場合、有効にします。それ以外の場合は無効にします。

例外

ブラウザで実行した場合
Mocha が INIT 状態でない場合

戻り値

タイプ: Mocha

reporter(reporterName, reporterOptionsopt) → {Mocha}

ソース

mocha.js, 322行目

参照

レポーターを reporter に設定します。デフォルトは "spec" です。

例

// Use XUnit reporter and direct its output to file
mocha.reporter('xunit', { output: '/path/to/testspec.xunit.xml' });

Parameters

名前	タイプ	属性	説明
`reporterName`	文字列 \| 関数		レポーター名またはコンストラクタ。
`reporterOptions`	オブジェクト	<オプション>	レポーターの設定に使用されるオプション。

例外

要求されたレポーターをロードできない場合
タイプ エラー

戻り値

this

タイプ: Mocha

retries(retry) → {Mocha}

ソース

mocha.js, 761行目

参照

失敗したテストを再試行する回数を設定します。

例

// Allow any failed test to retry one more time
mocha.retries(1);

Parameters

名前	タイプ	説明
`retry`	数値	失敗したテストを再試行する回数。

戻り値

this

タイプ: Mocha

rootHooks(hooksopt)

ソース

mocha.js, 1046行目

フックをルートスイートに割り当てます

Parameters

名前	タイプ	属性	説明
`hooks`	MochaRootHookObject	<オプション>	ルートスイートに割り当てるフック

run(fnopt) → {Runner}

ソース

mocha.js, 964行目

参照

テストを複数回実行する場合（または、require キャッシュに
すでにあるファイルでテストを実行する場合）、必ず最初にキャッシュからクリアしてください。
キャッシュからクリアしてください！

例

// exit with non-zero status if there were test failures
mocha.run(failures => process.exitCode = failures ? 1 : 0);

Parameters

名前	タイプ	属性	説明
`fn`	DoneCB	<オプション>	テストの実行が完了したときに呼び出されるコールバック。

戻り値

ランナーインスタンス

タイプ: Runner

runGlobalSetup(contextopt) → {Promise:.<object:>}

ソース

mocha.js, 1173行目

グローバルセットアップフィクスチャが定義されている場合は、シーケンシャルに実行します。

これは、runGlobalSetup オプションが false でない限り、Mocha#run によって自動的に呼び出されます。 Mocha#enableGlobalSetup を参照してください。

この関数が解決するコンテキストオブジェクトは、Mocha#runGlobalTeardown によって消費される必要があります。

Parameters

名前	タイプ	属性	説明
`context`	object	<オプション>	すでにコンテキストオブジェクトがある場合

戻り値

コンテキストオブジェクト

タイプ: Promise:.<object:>

runGlobalTeardown(contextopt) → {Promise:.<object:>}

ソース

mocha.js, 1193行目

グローバルティアダウンフィクスチャが定義されている場合は、シーケンシャルに実行します。

これは、runGlobalTeardown オプションが false でない限り、Mocha#run によって自動的に呼び出されます。 Mocha#enableGlobalTeardown を参照してください。

可能な場合は、Mocha#runGlobalSetup によって返されたコンテキストオブジェクトで呼び出す必要があります。

Parameters

名前	タイプ	属性	説明
`context`	object	<オプション>	すでにコンテキストオブジェクトがある場合

戻り値

コンテキストオブジェクト

タイプ: Promise:.<object:>

slow(msecs) → {Mocha}

ソース

mocha.js, 783行目

参照

CLIオプション

遅さのしきい値を設定します。

例

// Sets "slow" threshold to half a second
mocha.slow(500);

// Same as above but using string argument
mocha.slow('0.5s');

Parameters

名前	タイプ	説明
`msecs`	数値	遅さのしきい値。

戻り値

this

タイプ: Mocha

timeout(msecs) → {Mocha}

タイムアウトのしきい値を設定します。

ソース

mocha.js, 742行目

参照

文字列引数は、「2秒」などの省略形を使用でき、変換されます。
値が 0 の場合、タイムアウトは無効になります。

例

// Sets timeout to one second
mocha.timeout(1000);

// Same as above but using string argument
mocha.timeout('1s');

Parameters

名前	タイプ	説明
`msecs`	数値 \| 文字列	タイムアウト閾値。

戻り値

this

タイプ: Mocha

ui(uiopt) → {Mocha}

ソース

mocha.js, 369行目

参照

テスト UI name を設定します。デフォルトは "bdd" です。

Parameters

名前	タイプ	属性	デフォルト	説明
`ui`	文字列 \| 関数	<オプション>	`bdd`	インターフェース名またはクラス。

例外

要求されたインターフェースをロードできない場合
タイプ エラー

戻り値

this

タイプ: Mocha

unloadFiles() → {Mocha}

ソース

mocha.js, 492行目

参照

Mocha#run

これにより、必要なファイルを「新鮮に」再ロードできるようになり、Mocha インスタンスをプログラムで再利用する機能が提供されます。
Mocha インスタンスをプログラムで再利用する機能が提供されます。
注意: ESM モジュールファイルはキャッシュからクリアしません

コンシューマー向け - 内部では使用されません

戻り値

this

タイプ: Mocha