maxGraphemes

Creates a max graphemes validation action.

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

Generics

TInput extends string
TRequirement extends number
TMessage extends ErrorMessage<MaxGraphemesIssue<TInput, TRequirement>> | undefined

Parameters

requirement TRequirement
message TMessage

Explanation

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

Hint: The number of characters per grapheme is not limited. You may want to consider combining maxGraphemes with maxLength or maxBytes to set a stricter limit.

Returns

Action MaxGraphemesAction<TInput, TRequirement, TMessage>

Examples

The following examples show how maxGraphemes can be used.

Max graphemes schema

Schema to validate a string with a maximum of 8 graphemes.

const MaxGraphemesSchema = v.pipe(
  v.string(),
  v.maxGraphemes(8, 'The string must not exceed 8 graphemes.')
);

The following APIs can be combined with maxGraphemes.

Schemas

Methods

pipe