symbol

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

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

Дженерики

• TMessage extends ErrorMessage<SymbolIssue> | undefined

Параметры

• message TMessage

Объяснение

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

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

• Schema SymbolSchema<TMessage>

Примеры

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

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

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

const schema = v.symbol('A symbol is required');

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

Следующие API могут быть объединены с symbol.

Схемы

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