Skip to main content

Function: minLength()

minLength(min, errorMessage?): Validator<string, string, string>

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

Validates minimum string length.

Parameters

min

number

Minimum length

errorMessage?

string

Custom error message (optional)

Returns

Validator<string, string, string>

Validator that checks minimum length

Example

minLength(3)('John') // => Valid('John')
minLength(3)('Jo') // => Invalid(['Must be at least 3 characters'])
minLength(3, 'Too short')('Jo') // => Invalid(['Too short'])