boolean

Создает схему boolean.

const Schema = v.boolean<TMessage>(message);

Дженерики

• TMessage extends ErrorMessage<BooleanIssue> | undefined

Параметры

• message TMessage

Объяснение

С помощью boolean вы можете валидировать тип входных данных. Если входные данные не являются boolean, вы можете использовать message для настройки сообщения об ошибке.

Вместо использования pipe для принудительного задания значения true или false, в большинстве случаев имеет смысл использовать literal для лучшей типизации.

Возвращаемое значение

• Schema BooleanSchema<TMessage>

Примеры

Следующие примеры показывают, как можно использовать boolean.

Пользовательское сообщение

Схема boolean с пользовательским сообщением об ошибке.

const BooleanSchema = v.boolean('A boolean is required');

Связанные ресурсы

Следующие API можно комбинировать с boolean.

Схемы

array, exactOptional, intersect, lazy, looseObject, looseTuple, map, nonNullable, nonNullish, nonOptional, nullable, nullish, object, objectWithRest, optional, record, set, strictObject, strictTuple, tuple, tupleWithRest, undefinedable, union

Методы

assert, config, fallback, getDefault, getDefaults, getFallback, getFallbacks, is, message, parse, parser, pipe, safeParse, safeParser

Действия

check, brand, description, flavor, gtValue, guard, ltValue, maxValue, maxWords, metadata, minValue, notValue, notValues, rawCheck, rawTransform, readonly, title, toMaxValue, toMinValue, transform, value, values

Утилиты

entriesFromList, isOfKind, isOfType