文字列

文字列関連のエントリを生成するモジュールです。

モジュール概要

A-Z の文字のみを含む文字列には、{{$string.alpha}} を使用します。数字も追加するには、{{$string.alphanumeric}} を使用します。句読点や記号のみが必要な場合は、{{$string.symbol}} を使用します。ASCII 文字の完全なセットには、{{$string.sample}} を使用します。カスタムの文字セットには、{{$string.fromCharacters}} を使用します。

10 進数の数字の文字列には、{{$string.numeric}} を使用します。その他の基数には、{{$string.binary}}、{{$string.octal}}、または {{$string.hexadecimal}} を使用します。

{{$string.uuid}} または {{$string.nanoid}} を使用して、標準的な ID 文字列を生成できます。

関連モジュール

絵文字は {{$internet.emoji}} にあります。

Helpers モジュールには、文字列関連のメソッドが多数含まれています。

alpha

英字アルファベットの文字で構成される文字列を生成します。

パラメータ

名前	型	デフォルト	説明
casing	Casing	`mixed`	文字の大文字・小文字の指定です。
exclude	string \| Array<AlphaChar \| string>	`[]`	生成される文字列から除外する文字の配列です。
min	number	`1`	生成する最小文字数です。
max	number	`1`	生成する最大文字数です。
length	number	`1`	生成する文字数の範囲です。

戻り値: string

例

alphanumeric

英字と数字で構成される文字列を生成します。

パラメータ

名前	型	デフォルト	説明
casing	Casing	`mixed`	文字の大文字・小文字の指定です。
exclude	string \| Array<AlphaNumericChar \| string>	`[]`	生成される文字列から除外する文字の配列です。
min	number	`1`	生成する最小文字数です。
max	number	`1`	生成する最大文字数です。
length	number	`1`	生成する文字数の範囲です。

戻り値: string

例

binary

binary 文字列を返します。

パラメータ

名前	型	デフォルト	説明
prefix	string	`0b`	生成される数値のプレフィックスです。
min	number	`1`	プレフィックスの後に生成する最小文字数です。
max	number	`1`	プレフィックスの後に生成する最大文字数です。
length	number	`1`	生成する文字数の範囲です。

戻り値: string

例

fromCharacters

指定された文字から文字列を生成します。

パラメータ

名前	型	説明
characters	string \| string[]	文字列に使用する文字です。文字列または文字の配列を指定できます。配列の場合、各要素は、複数文字を含む文字列であっても単一の文字として扱われます。
min	number	生成する文字列の最小長です。
max	number	生成する文字列の最大長です。

戻り値: string

例

hexadecimal

hexadecimal 文字列を返します。

パラメータ

名前	型	デフォルト	説明
casing	Casing	`mixed`	文字の大文字・小文字の指定です。
prefix	string	`0x`	生成される数値のプレフィックスです。
min	number	`1`	プレフィックスの後に生成する最小文字数です。
max	number	`1`	プレフィックスの後に生成する最大文字数です。
length	number	`1`	プレフィックスの後に生成する文字数の範囲です。

戻り値: string

例

nanoid

Nano ID を生成します。

パラメータ

名前	型	デフォルト	説明
min	number	`1`	生成する Nano ID の最小長です。
max	number	`1`	生成する Nano ID の最大長です。
length	number	`21`	生成される文字列の長さです。

戻り値: string

例

numeric

指定された長さの数字文字列を生成します。

パラメータ

名前	型	デフォルト	説明
exclude	string \| Array<NumericChar \| string>	`[]`	生成される文字列から除外する数字の配列です。
allowLeadingZeros	boolean	`true`	先頭のゼロを許可するかどうかです。
min	number	`1`	生成する最小桁数です。
max	number	`1`	生成する最大桁数です。
length	number	`1`	生成する桁数の範囲です。

戻り値: string

例

octal

octal 文字列を返します。

パラメータ

名前	型	デフォルト	説明
min	number	`1`	プレフィックスの後に生成する最小桁数です。
max	number	`1`	プレフィックスの後に生成する最大桁数です。
length	number	`1`	プレフィックスの後に生成する桁数の範囲です。
prefix	string	`0o`	生成される数値のプレフィックスです。

戻り値: string

例

sample

33 から 125（! から }）までの UTF-16 文字を含む文字列を返します。

パラメータ

名前	型	デフォルト	説明
min	number		生成する最小文字数です。
max	number		生成する最大文字数です。

戻り値: string

例

symbol

次のリストに含まれる特殊文字のみを含む文字列を返します。

パラメータ

名前	型	デフォルト	説明
min	number		生成する特殊文字の最小数です。
max	number		生成する特殊文字の最大数です。

戻り値: string

例

uuid

UUID v4（Universally Unique Identifier）を返します。

戻り値: string

例

モジュール概要#

alpha#

alphanumeric#

binary#

fromCharacters#

hexadecimal#

nanoid#

numeric#

octal#

sample#

symbol#

uuid#

モジュール概要

alpha

alphanumeric

binary

fromCharacters

hexadecimal

nanoid

numeric

octal

sample

symbol

uuid