Skip to main content

Function: maxItems()

maxItems<T>(maxCount, errorMessage?): Validator<T[], T[], string>

Defined in: validation/validators/index.ts:370

Validates array has maximum length.

Type Parameters​

T​

T

Parameters​

maxCount​

number

Maximum number of elements

errorMessage?​

string

Custom error message (optional)

Returns​

Validator<T[], T[], string>

Validator that checks maximum array length

Example​

maxItems(5)([1, 2, 3]) // => Valid([1, 2, 3])
maxItems(2)([1, 2, 3]) // => Invalid(['Must have at most 2 items'])