boolean

Логическое значение true или false.

Сигнатура

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

Параметры

Параметр	Тип	Описание
msg	Message	Своё сообщение. Заменяет сообщения по умолчанию для всех ошибок этой схемы

Пропускает

Только 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 — обязательное согласие