literal

Создаёт литеральную схему.

const Schema = v.literal<TLiteral, TMessage>(literal, message);

Дженерики

• TLiteral extends Literal
• TMessage extends ErrorMessage<LiteralIssue> | undefined

Параметры

• literal TLiteral
• message TMessage

Объяснение

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

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

• Schema LiteralSchema<TLiteral, TMessage>

Примеры

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

Строковый литерал

Схема для валидации строкового литерала.

const StringLiteralSchema = v.literal('foo');

Числовой литерал

Схема для валидации числового литерала.

const NumberLiteralSchema = v.literal(26);

Логический литерал

Схема для валидации логического литерала.

const BooleanLiteralSchema = v.literal(true);

Связанное

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

Схемы

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, guard, metadata, rawCheck, rawTransform, readonly, title, transform

Утилиты

entriesFromList, isOfKind, isOfType