字符串（String）

生成字符串相关条目的模块。

概述

若要生成仅包含 A-Z 字符的字符串，请使用 {{$string.alpha}}。若要同时添加数字，请使用 {{$string.alphanumeric}}。如果你只需要标点符号，请使用 {{$string.symbol}}。若要使用完整的 ASCII 字符集，请使用 {{$string.sample}}。若要使用自定义的字符集，请使用 {{$string.fromCharacters}}。

若要生成十进制数字的字符串，请使用 {{$string.numeric}}。对于其他进制，请使用 {{$string.binary}}、{{$string.octal}} 或 {{$string.hexadecimal}}）。

你可以使用 {{$string.uuid}} 或 {{$string.nanoid}} 生成标准的 ID 字符串。

相关模块

Emoji 表情符号可以在 {{$internet.emoji}} 中找到。辅助函数（Helpers）模块包含许多与字符串相关的方法。

alpha

生成一个由英文字母组成的字符串。

参数

名称	类型	默认值	描述
casing	大小写	`mixed`	字符的大小写。
exclude	字符串 \| 字符数组	`[]`	在生成的字符串中应排除的字符数组。
min	数字	`1`	要生成的最小字符数。
max	数字	`1`	要生成的最大字符数。
length	数字	`1`	要生成的字符范围。

返回: 字符串

示例

alphanumeric

生成一个由字母字符和数字组成的字符串。

参数

名称	类型	默认值	描述
casing	大小写	`mixed`	字符的大小写。
exclude	字符串 \| 字符数组	`[]`	在生成的字符串中应排除的字符数组。
min	数字	`1`	要生成的最小字符数。
max	数字	`1`	要生成的最大字符数。
length	数字	`1`	要生成的字符范围。

返回: 字符串

示例

binary

返回一个二进制字符串。

参数

名称	类型	默认值	描述
prefix	字符串	`0b`	生成的数字的前缀。
min	数字	`1`	前缀后要生成的最小字符数。
max	数字	`1`	前缀后要生成的最大字符数。
length	数字	`1`	要生成的字符范围。

返回: 字符串

示例

fromCharacters

从给定的字符生成一个字符串。

参数

名称	类型	描述
characters	字符串 \| 字符串数组	用于字符串的字符。可以是字符串或字符数组。如果是数组，则即使是包含多个字符的字符串，每个元素也会被视为单个字符。
min	数字	要生成的字符串的最小长度。
max	数字	要生成的字符串的最大长度。

返回: 字符串

示例

hexadecimal

返回一个十六进制字符串。

参数

名称	类型	默认值	描述
casing	大小写	`mixed`	字符的大小写。
prefix	字符串	`0x`	生成的数字的前缀。
min	数字	`1`	前缀后要生成的最小字符数。
max	数字	`1`	前缀后要生成的最大字符数。
length	数字	`1`	前缀后要生成的字符范围。

返回: 字符串

示例

nanoid

生成一个 Nano ID。

参数

名称	类型	默认值	描述
min	数字	`1`	要生成的 Nano ID 的最小长度。
max	数字	`1`	要生成的 Nano ID 的最大长度。
length	数字	`21`	生成的字符串的长度。

返回: 字符串

示例

numeric

生成一个给定长度的数字字符串。

参数

名称	类型	默认值	描述
exclude	字符串 \| 字符数组	`[]`	在生成的字符串中应排除的数字数组。
allowLeadingZeros	布尔值	`true`	是否允许前导零。
min	数字	`1`	要生成的最小位数。
max	数字	`1`	要生成的最大位数。
length	数字	`1`	要生成的数字范围。

返回: 字符串

示例

octal

返回一个八进制字符串。

参数

名称	类型	默认值	描述
min	数字	`1`	前缀后要生成的最小位数。
max	数字	`1`	前缀后要生成的最大位数。
length	数字	`1`	前缀后要生成的数字范围。
prefix	字符串	`0o`	生成的数字的前缀。

返回: 字符串

示例

sample

返回一个包含 33 到 125 之间的 UTF-16 字符（! 到 }）的字符串。

参数

名称	类型	默认值	描述
min	数字		要生成的最小字符数。
max	数字		要生成的最大字符数。

返回: 字符串

示例

symbol

返回一个仅包含以下列表中的特殊字符的字符串：

参数

名称	类型	默认值	描述
min	数字		要生成的最小特殊字符数。
max	数字		要生成的最大特殊字符数。

返回: 字符串

示例

uuid

返回一个 UUID v4 (通用唯一标识符)。

返回: 字符串

示例

alpha#

alphanumeric#

binary#

fromCharacters#

hexadecimal#

nanoid#

numeric#

octal#

sample#

symbol#

uuid#

alpha

alphanumeric

binary

fromCharacters

hexadecimal

nanoid

numeric

octal

sample

symbol

uuid