string

字符串。空字符串 '' 被视为未填写。

签名

function string(msg?: Message): Schema<string>

参数

参数	类型	说明
msg	Message	自定义信息。替换该 Schema 所有错误的默认信息

接受的值

任意非空字符串。数字不会被转换为字符串 —— 请使用 coerce.string。

undefined、null 和 '' 都被视为空值 —— 详见 空值。

错误代码

代码	触发条件	默认信息
required	值为空	Required
string	不是字符串	Must be a string

可以修改这些文本：见 错误信息与国际化。

注意事项

只包含空格的字符串 ' ' 可以通过校验。要拒绝它：pipe(string(), trim(), minLength(1))。

要允许空字符串作为值：optional(string(), '')。

示例

带规则的必填字段

const name = pipe(string('请输入姓名'), trim(), minLength(2), maxLength(50));

validate(name, '');        // 请输入姓名
validate(name, ' 李雷 ');  // 有效，data: '李雷'

另请参阅

• pipe：添加规则
• coerce.string：把数字转换为字符串
• 空值