Built-In Validator: minLength

The minLength validator checks that a string value has a length at least the minimum length provided.

If the value being validated is null or an empty string, then the result will be valid. This respects the rule of thumb described in the notes for the required validator.

Named Props

minLength: The minimum length compared against

Parameters

The minLength validator supports three parameter signatures:

minLength(value) where the value is used as the minLength named prop

minLength(propsObject) where the props object contains a minLength named prop

minLength(propsFunction) where the props function returns a props object with a minLength named prop

Usage

import validate, {minLength} from'strickland';
// As a value parameterconst minLengthOf3 = minLength(3);
// As a named propconst minLengthOf2 = minLength({
minLength: 2,
message: 'Must have a length of at least 2'
});
// As a function that resolves to have the named propconst minLengthValidator = minLength((context) => ({
minLength: context.minLength,
message: `Must have a length of at least ${context.minLength}`
}));