Function.arrayOf

umt / arrayOf

Function: arrayOf()

arrayOf<T, R>(validator, message?): (values) => ValidateCoreReturnType<T[]>

Defined in: Validate/array/arrayOf.ts:12

Creates an array validator that validates every element with a single validator

Type Parameters

T

T

Element type validated by the wrapped validator

R

R extends object

The return type of the wrapped validator (preserved so the inner type tag flows through)

Parameters

validator

(value) => R

Validator applied to each element (e.g. an object validator)

message?

string

Custom error message for array type validation

Returns

• Validator function for arrays whose elements satisfy the given validator

(values) => ValidateCoreReturnType<T[]>