arrayAsync

Creates an array schema.

const Schema = v.arrayAsync<TItem, TMessage>(item, message);

Generics

• TItem extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>
• TMessage extends ErrorMessage<ArrayIssue> | undefined

Parameters

• item TItem
• message TMessage

Explanation

With arrayAsync you can validate the data type of the input. If the input is not an array, you can use message to customize the error message.

If your array has a fixed length, consider using tupleAsync for a more precise typing.

Returns

• Schema ArraySchemaAsync<TItem, TMessage>

Examples

The following examples show how arrayAsync can be used.

Stored emails schema

Schema to validate an array of stored emails.

import { isEmailPresent } from '~/api';

const StoredEmailsSchema = v.arrayAsync(
  v.pipeAsync(
    v.string(),
    v.email(),
    v.checkAsync(isEmailPresent, 'The email is not in the database.')
  )
);

Related

The following APIs can be combined with arrayAsync.

Schemas

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

Methods

• config,
• getDefault,
• getFallback

Actions

• check,
• checkItems,
• brand,
• description,
• empty,
• everyItem,
• excludes,
• filterItems,
• findItem,
• includes,
• length,
• mapItems,
• maxLength,
• metadata,
• minLength,
• nonEmpty,
• notLength,
• partialCheck,
• rawCheck,
• rawTransform,
• readonly,
• reduceItems,
• someItem,
• sortItems,
• title,
• transform

Utils

• entriesFromList,
• isOfKind,
• isOfType

Async

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