utils

Mochaのコードベース全体で使用される様々なユーティリティ関数。

ソース

メンバー

(static) inherits

ソース

あるコンストラクタから別のコンストラクタへプロトタイプメソッドを継承します。

(inner) path

ソース

モジュールの依存関係。

メソッド

(static) clamp(value, range) → {number}

ソース

数値の値を包含範囲にクランプします。

Parameters
名前型説明
valuenumber

クランプされる値。

rangeArray:.<number:>

[最小, 最大]の範囲を指定する2要素の配列。

戻り値

クランプされた値

型
number

(static) clean(str) → {string}

ソース

strから関数定義を削除し、先頭の空白に合わせて再インデントします。

Parameters
名前型説明
strstring
戻り値
型
string

(static) createMap(…objopt) → {Object}

ソース
参照

「マップ」とは、目的のためにプロトタイプを持たないオブジェクトのことです。場合によっては
これは、特に環境がサポートしていない場合は、Mapよりも適切です。
Mochaの公開APIでの使用を推奨します。

Parameters
名前型属性説明
obj*<任意>
<繰り返し可能>

Object.assign()への引数。

戻り値

プロトタイプを持たず、...objプロパティを持つオブジェクト

型
Object

(static) defineConstants(…objopt) → {Object}

ソース
参照

これはcreateMapと異なる点は、
結果がフリーズされるため、引数が空でない必要があることです。

Parameters
名前型属性説明
obj*<任意>
<繰り返し可能>

Object.assign()への引数。

例外

引数が空でないオブジェクトでない場合。

型
TypeError
戻り値

プロトタイプを持たず、...objプロパティを持つフリーズされたオブジェクト

型
Object

(static) getMochaID(objopt) → {string|void}

ソース

オブジェクトにMocha IDが存在する場合は、それを取得します。

Parameters
名前型属性説明
obj*<任意>

Object

戻り値
型
string | void

(static) isPromise(value) → {boolean}

ソース

粗雑ですが、効果的です。

Parameters
名前型説明
value*
戻り値

valueがPromiseかどうか

型
boolean

(static) noop()

ソース

これはnoopです。

(static) stackTraceFilter() → {function}

このフィルターはmocha-cleanモジュールに基づいています(参照: github.com/rstacruz/mocha-clean)。

ソース

この関数を呼び出すと、Error.stackを入力として取得し、
整形された出力を返すフィルター関数が得られます。
(例: スタックトレースからMochaおよび内部ノード関数を削除します)。

戻り値
型
function

(static) uniqueID() → {string}

ソース

新しい一意の識別子を作成します。
暗号学的に安全なIDは作成しません。
nanoid/non-secureの単純なコピー

戻り値

一意の識別子

型
string