some

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

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

Generics

• TInput extends any[]

Parameters

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

Explanation

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

Returns

• Validation SomeValidation<TInput>

Examples

The following examples show how some can be used.

Unsorted array schema

Schema to validate that an array is not sorted.

const UnsortedArraySchema = array(number(), [
  some(
    (value, index, array) => array.length === 1 || value < array[index - 1],
    'The numbers must not be sorted in ascending order.'
  ),
]);

Related

The following APIs can be combined with some.

Schemas

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