minCodePoints

Creates a min code points validation action.

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

Generics

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

Parameters

• requirement TRequirement
• message TMessage

Explanation

With minCodePoints you can validate the minimum number of Unicode code points in a string. Code points are not the same as UTF-16 code units or user-perceived characters (graphemes): 😀 consists of 2 UTF-16 code units, 1 code point, and 1 grapheme, while 👨🏽‍👩🏽 consists of 5 code points but 1 grapheme. If the number of code points is below the requirement, you can use message to customize the error message.

Hint: This action can help enforce minimum password length requirements measured in Unicode code points. NIST SP 800-63B requires us to count the length of a password in code points.

Returns

• Action MinCodePointsAction<TInput, TRequirement, TMessage>

Examples

The following examples show how minCodePoints can be used.

Min code points schema

Schema to validate a string with a minimum of 8 code points.

const MinCodePointsSchema = v.pipe(
  v.string(),
  v.minCodePoints(8, 'The string must contain at least 8 code points.')
);

Related

The following APIs can be combined with minCodePoints.

Schemas

any, custom, string

Methods

pipe

Actions

minGraphemes, minLength

Utils

isOfKind, isOfType