Skip to main content

Function: between()

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

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

Validates number is within a range.

Parameters​

minimum​

number

Minimum value (inclusive)

maximum​

number

Maximum value (inclusive)

errorMessage?​

string

Custom error message (optional)

Returns​

Validator<number, number, string>

Validator that checks range

Example​

between(0, 100)(50) // => Valid(50)
between(0, 100)(-1) // => Invalid(['Must be between 0 and 100'])
between(0, 100)(150) // => Invalid(['Must be between 0 and 100'])