maxLength

Creates a max length validation action.

const Action = v.maxLength<TInput, TRequirement, TMessage>(
  requirement,
  message
);

Generics

Parameters

  • requirement TRequirement
  • message TMessage

Explanation

With maxLength 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 maxLength can be used.

Maximum string length

Schema to validate a string with a maximum length of 32 characters.

const MaxStringSchema = v.pipe(
  v.string(),
  v.maxLength(32, 'The string must not exceed 32 characters.')
);

Maximum array length

Schema to validate an array with a maximum length of 5 items.

const MaxArraySchema = v.pipe(
  v.array(v.number()),
  v.maxLength(5, 'The array must not exceed 5 numbers.')
);

The following APIs can be combined with maxLength.

Schemas

Methods

Utils

Contributors

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

  • GitHub profile picture of fabian-hiller
  • GitHub profile picture of depsimon

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 antfu
  • GitHub profile picture of Thanaen
  • GitHub profile picture of osdiab
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of F0rce
  • GitHub profile picture of fabulousgk
  • GitHub profile picture of jdgamble555
  • GitHub profile picture of nickytonline
  • GitHub profile picture of KubaJastrz
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of luckasnix
  • GitHub profile picture of andrew-3kb
  • GitHub profile picture of dslatkin