Built-In Validator: maxLength

The maxLength validator checks that a string value has a length at most the maximum 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

maxLength: The maximum length compared against

Parameters

The maxLength validator supports three parameter signatures:

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

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

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

Usage

import validate, {maxLength} from'strickland';
// As a value parameterconst maxLengthOf3 = maxLength(3);
// As a named propconst maxLengthOf2 = maxLength({
maxLength: 2,
message: 'Must have a length of at most 2'
});
// As a function that resolves to have the named propconst maxLengthValidator = maxLength((context) => ({
maxLength: context.maxLength,
message: `Must have a length of at most ${context.maxLength}`
}));