lib/errors - ドキュメント

エラーコード、スロー可能なエラーオブジェクトを作成するためのファクトリー関数、
および警告/非推奨関数を含みます。

ソース

errors.js、5行目

名前空間

constants

メソッド

(静的) createFatalError(message) → {Error}

ソース

errors.js、320行目

回復不能なエラーが発生した場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	説明
`message`	文字列	表示されるエラーメッセージ。

戻り値

エラー状態を詳述するインスタンス

型: Error

(静的) createForbiddenExclusivityError(mocha) → {Error}

ソース

errors.js、443行目

.only() が --forbid-only と共に使用された場合にスローされるエラーオブジェクトを作成します。
--forbid-only.

Parameters

名前	型	説明
`mocha`	Mocha	Mocha インスタンス

戻り値

constants.FORBIDDEN_EXCLUSIVITY コードのエラー

型: Error

(静的) createInvalidArgumentTypeError(message, argument, expected) → {Error}

ソース

errors.js、267行目

引数がサポートされている型を使用していない場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	説明
`message`	文字列	表示されるエラーメッセージ。
`argument`	文字列	引数名。
`expected`	文字列	期待される引数のデータ型。

戻り値

エラー状態を詳述するインスタンス

型: Error

(静的) createInvalidArgumentValueError(message, argument, value, reasonopt) → {Error}

ソース

errors.js、287行目

引数がサポートされている値を使用していない場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	属性	説明
`message`	文字列		表示されるエラーメッセージ。
`argument`	文字列		引数名。
`value`	文字列		引数値。
`reason`	文字列	<オプション>	値が無効である理由。

戻り値

エラー状態を詳述するインスタンス

型: Error

(静的) createInvalidExceptionError(message) → {Error}

ソース

errors.js、304行目

例外がキャッチされたが、Error が偽または未定義の場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	説明
`message`	文字列	表示されるエラーメッセージ。

戻り値

エラー状態を詳述するインスタンス

型: Error

(静的) createInvalidInterfaceError(message, ui) → {Error}

ソース

errors.js、222行目

オプションで指定されたインターフェースが見つからなかった場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	説明
`message`	文字列	表示されるエラーメッセージ。
`ui`	文字列	ユーザーが指定したインターフェース値。

戻り値

エラー状態を詳述するインスタンス

型: Error

(静的) createInvalidLegacyPluginError(message, pluginType, pluginIdopt) → {Error}

ソース

errors.js、338行目

プラグインの種類に基づいて、動的にプラグインの種類に固有のエラーを作成します。

Parameters

名前	型	属性	説明
`message`	文字列		エラーメッセージ
`pluginType`	"reporter" \| "ui"		プラグインの種類。将来: 必要に応じて拡張します。
`pluginId`	文字列	<オプション>	プラグインの名前/パス（存在する場合）。

スロー

pluginType が不明な場合。

戻り値

型: Error

(静的) createInvalidPluginDefinitionError(msg, pluginDefopt) → {Error}

ソース

errors.js、461行目

プラグインの定義が無効な場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	属性	説明
`msg`	文字列		エラーメッセージ
`pluginDef`	PluginDefinition	<オプション>	問題のあるプラグイン定義。

戻り値

constants.INVALID_PLUGIN_DEFINITION コードのエラー

型: Error

(静的) createInvalidPluginError(message, pluginType, pluginIdopt) → {Error}

ソース

errors.js、360行目

非推奨

はい

非推奨。createInvalidLegacyPluginError を代わりに使用してください。プラグインの種類に基づいて、動的にプラグインの種類に固有のエラーを作成します。

Parameters

名前	型	属性	説明
`message`	文字列		エラーメッセージ
`pluginType`	"reporter" \| "interface"		プラグインの種類。将来: 必要に応じて拡張します。
`pluginId`	文字列	<オプション>	プラグインの名前/パス（存在する場合）。

スロー

pluginType が不明な場合。

戻り値

型: Error

(静的) createInvalidPluginImplementationError(msg, optsopt) → {Error}

ソース

errors.js、478行目

プラグインの実装（ユーザーコード）が無効な場合にスローされるエラーオブジェクトを作成します。

Parameters

名前型属性説明

msg

文字列

エラーメッセージ

opts

オブジェクト

<オプション>

プラグイン定義とユーザーが提供した実装。

プロパティ

名前	型	属性	説明
`pluginDef`	PluginDefinition	<オプション>	プラグイン定義
`pluginImpl`	*	<オプション>	プラグインの実装（ユーザーが提供）。

戻り値

constants.INVALID_PLUGIN_DEFINITION コードのエラー

型: Error

(静的) createMissingArgumentError(message, argument, expected) → {Error}

ソース

errors.js、253行目

引数が不足している場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	説明
`message`	文字列	表示されるエラーメッセージ。
`argument`	文字列	引数名。
`expected`	文字列	期待される引数のデータ型。

戻り値

エラー状態を詳述するインスタンス

型: Error

(静的) createMochaInstanceAlreadyDisposedError(message, cleanReferencesAfterRun, instance)

ソース

errors.js、372行目

Mocha オブジェクトの run メソッドが既に破棄されている状態で実行された場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	説明
`message`	文字列	表示されるエラーメッセージ。
`cleanReferencesAfterRun`	ブール値	`cleanReferencesAfterRun` の値。
`instance`	Mocha	このエラーをスローした Mocha インスタンス。

(静的) createMochaInstanceAlreadyRunningError(message)

ソース

errors.js、390行目

テストの実行中に Mocha オブジェクトの run メソッドが呼び出された場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	説明
`message`	文字列	表示されるエラーメッセージ。

(静的) createMultipleDoneError(runnable, originalErropt) → {Error}

ソース

errors.js、406行目

テスト内で done() が複数回呼び出された場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	属性	説明
`runnable`	Runnable		元の runnable。
`originalErr`	Error	<オプション>	元のエラー（存在する場合）。

戻り値

エラー状態を詳述するインスタンス

型: Error

(静的) createNoFilesMatchPatternError(message, pattern) → {Error}

ソース

errors.js、191行目

指定されたパターンを使用してテスト対象のファイルが見つからなかった場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	説明
`message`	文字列	表示されるエラーメッセージ。
`pattern`	文字列	ユーザーが指定した引数値。

戻り値

エラー状態を詳述するインスタンス

型: Error

(静的) createTimeoutError(msg, timeoutopt, fileopt) → {MochaTimeoutError}

ソース

errors.js、497行目

実行可能ファイルが許容される実行時間を超過した場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	属性	説明
`msg`	文字列		エラーメッセージ
`timeout`	数値	<オプション>	ミリ秒単位のタイムアウト。
`file`	文字列	<オプション>	ファイル（指定されている場合）。

戻り値

型: MochaTimeoutError

(静的) createUnparsableFileError(message, filename) → {Error}

ソース

errors.js、513行目

ファイルが解析できない場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	説明
`message`	文字列	表示されるエラーメッセージ。
`filename`	文字列	ファイル名。

戻り値

constants.UNPARSABLE_FILE コードのエラー

型: Error

(静的) createUnsupportedError(message) → {Error}

ソース

errors.js、237行目

動作、オプション、またはパラメーターがサポートされていない場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	説明
`message`	文字列	表示されるエラーメッセージ。

戻り値

エラー状態を詳述するインスタンス

型: Error

(静的) isMochaError(err) → {boolean}

ソース

errors.js、527行目

エラーが Mocha から発生した場合、true を返します。
偽陰性になる可能性がありますが、偽陽性になることはありません。

Parameters

名前	型	説明
`err`	*	Error、または任意のオブジェクト。

戻り値

型: ブール値

(内部) createInvalidReporterError(message, reporter) → {Error}

ソース

errors.js、206行目

オプションで指定されたレポーターが見つからない場合にスローされるエラーオブジェクトを作成します。

Parameters

名前	型	説明
`message`	文字列	表示されるエラーメッセージ。
`reporter`	文字列	ユーザーが指定したレポーター値。

戻り値

エラー状態を詳述するインスタンス

型: Error

型定義

MochaTimeoutError

ソース

errors.js、556行目

プロパティ

名前	型	属性	説明
`コード`	constants.TIMEOUT		エラーコード
`timeout`	数値	<null許容>	ミリ秒単位のタイムアウト。
`file`	文字列	<null許容>	ファイルパス（指定されている場合）

Runnableがタイムアウトした場合にスローされるエラー

型

Error