promise

Создает схему промиса.

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

Дженерики

• TMessage extends ErrorMessage<PromiseIssue> | undefined

Параметры

• message TMessage

Объяснение

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

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

• Schema PromiseSchema<TMessage>

Примеры

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

Промис с числом

Схема для валидации промиса, который разрешается в число.

const NumberPromiseSchema = v.pipeAsync(
  v.promise(),
  v.awaitAsync(),
  v.number()
);

Связанные элементы

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

Схемы

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

Действия

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

Утилиты

entriesFromList, isOfKind, isOfType