boolean

布尔值：true 或 false。

签名

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

参数

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

接受的值

只接受 true 和 false。false 是有效值，而不是空值。

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

错误代码

代码	触发条件	默认信息
required	值为空	Required
boolean	不是 true/false	Must be a boolean

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

复选框和 query

表单复选框以 "on" 提交，query 参数为 "true"/"1"。请使用 coerce.boolean。

如果必须为 true（例如“我同意条款”），请使用 literal(true)。

示例

订阅邮件

const Settings = object({
  newsletter: optional(boolean(), false),
});

validate(Settings, {}).data;                   // { newsletter: false }
validate(Settings, { newsletter: true }).data; // { newsletter: true }

另请参阅

• coerce.boolean
• literal：必须同意