array

Creates an array schema.

// Array schema with an optional pipe
const Schema = array<TItem>(item, pipe);

// Array schema with an optional message and pipe
const Schema = array<TItem>(item, message, pipe);

Generics

TItem extends BaseSchema

Parameters

item TItem
message ErrorMessage | undefined
pipe Pipe<Output<TItem>[]> | undefined

Explanation

With array you can validate the data type of the input and with pipe you can transform and validate the further details of the array. 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 tuple for a more precise typing.

Returns

Schema ArraySchema<TItem>

Examples

The following examples show how array can be used.

String array schema

Schema to validate an array of strings.

const StringArraySchema = array(string(), 'An array is required.');

Object array schema

Schema to validate an array of objects.

const ObjectArraySchema = array(object({ key: string() }));

Validate length

Schema that validates the length of an array.

const ArrayLengthSchema = array(number(), [minLength(1), maxLength(3)]);

Validate content

Schema that validates the content of an array.

const ArrayContentSchema = array(string(), [includes('foo'), excludes('bar')]);

The following APIs can be combined with array.

Schemas

Methods

Transformations

toCustom