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

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

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.'),
]);

The following APIs can be combined with length.

Schemas

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of dailydotdev
  • GitHub profile picture of ivan-mihalic
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of Thanaen
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of caegdeveloper