promise

Creates a promise schema.

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

Generics

• TMessage extends ErrorMessage<PromiseIssue> | undefined

Parameters

• message TMessage

Explanation

With promise you can validate the data type of the input. If the input is not a promise, you can use message to customize the error message.

Returns

• Schema PromiseSchema<TMessage>

Examples

The following examples show how promise can be used.

Number promise

Schema to validate a promise that resolves to a number.

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

Related

The following APIs can be combined with promise.

Schemas

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

Methods

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

Actions

• check,
• brand,
• rawCheck,
• rawTransform,
• readonly,
• transform