maxWords

Creates a max words validation action.

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

Generics

  • TInput extends string
  • TLocales extends Intl.LocalesArgument
  • TRequirement extends number
  • TMessage extends ErrorMessage<MaxWordsIssue<TInput, TRequirement>> | undefined

Parameters

  • locales TLocales
  • requirement TRequirement
  • message TMessage

Explanation

With maxWords you can validate the words of a string based on the specified locales. If the input does not match the requirement, you can use message to customize the error message.

Returns

Examples

The following examples show how maxWords can be used.

Max words schema

Schema to validate a string with a maximum of 300 words.

const MaxWordsSchema = v.pipe(
  v.string(),
  v.maxWords('en', 300, 'The string must not exceed 300 words.')
);

The following APIs can be combined with maxWords.

Schemas

Methods

Utils

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 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 isoden
  • GitHub profile picture of nickytonline
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of andrew-3kb
  • GitHub profile picture of dslatkin