Skip to main content

Function: min()

min(minimum, errorMessage?): Validator<number, number, string>

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

Validates number is greater than or equal to minimum.

Parameters​

minimum​

number

Minimum value (inclusive)

errorMessage?​

string

Custom error message (optional)

Returns​

Validator<number, number, string>

Validator that checks minimum value

Example​

min(0)(5) // => Valid(5)
min(0)(-1) // => Invalid(['Must be at least 0'])
min(18, 'Must be adult')(17) // => Invalid(['Must be adult'])