every

Creates a pipeline validation action that validates the items of an array.

const Validation = every<TInput>(requirement, message);

Generics

• TInput extends any[]

Parameters

• requirement (input: TInput[number], index: number, array: TInput[number][]) => boolean
• message ErrorMessage | undefined

Explanation

With every you can freely validate the items of an array and return true if they are valid or false otherwise. If not every item matches your requirement, you can use message to customize the error message.

Returns

• Validation EveryValidation<TInput>

Examples

The following examples show how every can be used.

Sorted array schema

Schema to validate that an array is sorted.

const SortedArraySchema = array(number(), [
  every(
    (value, index, array) => index === 0 || value >= array[index - 1],
    'The numbers must be sorted in ascending order.'
  ),
]);

Related

The following APIs can be combined with every.

Schemas

• any,
• array,
• instance,
• special,
• tuple,
• unknown