nonOptional

Создает схему, не являющуюся необязательной (non-optional).

Эту функцию схемы можно использовать для переопределения поведения optional.

const Schema = v.nonOptional<TWrapped, TMessage>(wrapped, message);

Дженерики

• TWrapped extends BaseSchema<unknown, unknown, BaseIssue<unknown>>
• TMessage extends ErrorMessage<NonOptionalIssue> | undefined

Параметры

• wrapped TWrapped
• message TMessage

Пояснение

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

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

• Schema NonOptionalSchema<TWrapped, TMessage>

Примеры

В следующих примерах показано, как можно использовать nonOptional.

Строка non-optional

Схема, которая не принимает undefined.

const NonOptionalStringSchema = v.nonOptional(v.optional(v.string()));

Распаковка non-optional

Используйте unwrap, чтобы отменить действие nonOptional.

const NonOptionalNumberSchema = v.nonOptional(v.optional(v.number()));
const OptionalNumberSchema = v.unwrap(NonOptionalNumberSchema);

Связанное

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

Схемы

any, array, bigint, blob, boolean, custom, date, enum, exactOptional, file, function, instance, intersect, lazy, literal, looseObject, looseTuple, map, nan, never, nonNullable, nonOptional, null, nullable, nullish, number, object, objectWithRest, optional, picklist, promise, record, set, strictObject, strictTuple, string, symbol, tuple, tupleWithRest, undefined, undefinedable, union, unknown, variant, void

Методы

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

Действия

check, brand, description, flavor, guard, metadata, partialCheck, rawCheck, rawTransform, readonly, title, transform

Утилиты

entriesFromList, isOfKind, isOfType