mapAsync

Creates a map schema.

const Schema = v.mapAsync<TKey, TValue, TMessage>(key, value, message);

Generics

• TKey extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>
• TValue extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>
• TMessage extends ErrorMessage<MapIssue> | undefined

Parameters

• key TKey
• value TValue
• message TMessage

Explanation

With mapAsync you can validate the data type of the input and whether the entries match key and value. If the input is not a map, you can use message to customize the error message.

Returns

• Schema MapSchemaAsync<TKey, TValue, TMessage>

Examples

The following examples show how mapAsync can be used.

Shopping items schema

Schema to validate a map with usernames that are allowed to shop as keys and the total items purchased as values.

import { isUserVerified } from '~/api';

const ShoppingItemsSchema = v.mapAsync(
  v.pipeAsync(
    v.string(),
    v.checkAsync(isUserVerified, 'The username is not allowed to shop.')
  ),
  v.pipe(v.number(), v.minValue(0))
);

Related

The following APIs can be combined with mapAsync.

Schemas

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

Methods

• config,
• getDefault,
• getFallback

Actions

• check,
• brand,
• maxSize,
• minSize,
• notSize,
• rawCheck,
• rawTransform,
• readonly,
• size,
• transform

Utils

• entriesFromList,
• isOfKind,
• isOfType

Async

• arrayAsync,
• checkAsync,
• customAsync,
• fallbackAsync,
• getDefaultsAsync,
• getFallbacksAsync,
• intersectAsync,
• lazyAsync,
• looseObjectAsync,
• looseTupleAsync,
• nonNullableAsync,
• nonNullishAsync,
• nonOptionalAsync,
• nullableAsync,
• nullishAsync,
• objectAsync,
• objectWithRestAsync,
• optionalAsync,
• parseAsync,
• parserAsync,
• pipeAsync,
• rawCheckAsync,
• rawTransformAsync,
• recordAsync,
• safeParseAsync,
• safeParserAsync,
• setAsync,
• strictObjectAsync,
• strictTupleAsync,
• transformAsync,
• tupleAsync,
• tupleWithRestAsync,
• unionAsync,
• variantAsync