length

Creates a pipeline validation action that validates the length of a string or array.

const Validation = length<TInput, TRequirement>(requirement, message);

Generics

• TInput extends string | any[]
• TRequirement extends number

Parameters

• requirement TRequirement
• message ErrorMessage | undefined

Explanation

With length you can validate the length of a string or array. If the input does not match the requirement, you can use message to customize the error message.

Returns

• Validation LengthValidation<TInput, TRequirement>

Examples

The following examples show how length can be used.

String schema

Schema to validate the length of a string.

const StringSchema = string([
  length(8, 'The string must be 8 characters long.'),
]);

Array schema

Schema to validate the length of an array.

const ArraySchema = array(number(), [
  length(100, 'The array must contain 100 numbers.'),
]);

Related

The following APIs can be combined with length.

Schemas

• any,
• array,
• instance,
• special,
• string,
• tuple,
• unknown