Helpers

faker メソッドの実装に役立つ、基本的な（シード依存の）操作を提供するさまざまなヘルパーメソッドのモジュールです。

モジュール概要

特に便利なメソッドは {{$helpers.arrayElement(['abc','123'])}} で、配列からランダムな要素を返します。これは、Faker に含まれていないカスタムデータを追加する際に便利です。

さまざまなパターンに従って文字列を生成できるメソッドがいくつかあります: {{$helpers.replaceSymbols('##??**')}} および {{$helpers.fromRegExp('[A-Z0-9]{4}-[A-Z0-9]{4}')}}。

arrayElement

指定された配列からランダムな要素を返します。

パラメータ

名前	型	デフォルト	説明
array	T[]		値を選択する元の配列です。

戻り値: T

例

arrayElements

指定された配列からランダムな要素のサブセットをランダムな順序で返します。

パラメータ

名前	型	説明
array	T[]	値を選択する元の配列です。
max	number	選択する要素の最大数です。
min	number	選択する要素の最小数です。

戻り値: T

例

fromRegExp

指定された正規表現のような式に一致する文字列を生成します。

この関数は、実際の RegExp を完全にはサポートしていません。グループ化、アンカー、文字クラスなどの機能はサポートされていません。RegExp に基づいてランダムに文字列を生成するライブラリをお探しの場合は、randexp.js を参照してください。

サポートされているパターン:

x{times} => x を正確に times 回繰り返します。

x{min,max} => x を min 回から max 回まで繰り返します。

[x-y] => x から y まで（両端を含む）の文字をランダムに取得します。

[x-y]{times} => x から y まで（両端を含む）の文字をランダムに取得し、times 回繰り返します。

[x-y]{min,max} => x から y まで（両端を含む）の文字をランダムに取得し、min 回から max 回まで繰り返します。

[^...] => 指定された範囲に含まれない ASCII の数字または文字をランダムに取得します。（例: [^0-9] はランダムな非数値文字を取得します）。

[-...] => 範囲にダッシュを含めます。使用する場合は、否定文字 ^ の後、任意の文字セットの前に配置する必要があります（例: [^-0-9] は数字またはダッシュを取得しません）。

/[x-y]/i => x から y まで（両端を含む）の大文字または小文字をランダムに取得します。

x? => x を含めるか含めないかをランダムに決定します。

[x-y]? => x から y まで（両端を含む）の文字を含めるか含めないかをランダムに決定します。

x* => x を 0 回以上繰り返します。

[x-y]* => x から y まで（両端を含む）の文字を 0 回以上繰り返します。

x+ => x を 1 回以上繰り返します。

[x-y]+ => x から y まで（両端を含む）の文字を 1 回以上繰り返します。

. => 任意の数字、文字、または記号になり得るワイルドカード ASCII 文字を返します。量指定子と組み合わせることもできます。

パラメータ

名前	型	デフォルト	説明
pattern	string \| RegExp		一致する文字列を生成するためのテンプレート文字列/RegExp です。

戻り値: string

スロー: 量指定子で min 値が max 値より大きい場合（例: #{10,5}）。無効な量指定子記号が渡された場合。

例

rangeToNumber

指定された数値または範囲を数値に変換するヘルパーメソッドです。

パラメータ

名前	型	デフォルト	説明
max	number		範囲の最大値です。
min	number		範囲の最小値です。

戻り値: number

例

replaceCreditCardSymbols

Luhn チェックサムを含むクレジットカードスキーマ内の記号とパターンを置換します。

パラメータ

名前	型	デフォルト	説明
string	string	`'6453-####-####-####-###L'`	クレジットカード形式のパターンです。
symbol	string	`'#'`	数字に置換する記号です。

戻り値: string

例

replaceSymbols

指定された文字列を記号ごとに解析し、プレースホルダーを適切に置換します。

# は数字（0 - 9）に置換されます。

? は大文字の英字（'A' - 'Z'）に置換されます。

* は数字または英字のいずれかに置換されます。

パラメータ

名前	型	デフォルト	説明
string	string		解析するテンプレート文字列です。

戻り値: string

例

slugify

指定された文字列をスラッグ化します。そのために、すべてのスペース（）はハイフン（-）に置換され、ドットとハイフンを除くほとんどの非単語文字は削除されます。

パラメータ

名前	型	デフォルト	説明
string	string		スラッグ化する入力です。

戻り値: string

例

モジュール概要#

arrayElement#

arrayElements#

fromRegExp#

rangeToNumber#

replaceCreditCardSymbols#

replaceSymbols#

slugify#

モジュール概要

arrayElement

arrayElements

fromRegExp

rangeToNumber

replaceCreditCardSymbols

replaceSymbols

slugify