notCodePoints

Creates a not code points validation action.

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

Generics

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

Parameters

• requirement TRequirement
• message TMessage

Explanation

With notCodePoints you can validate that a string does not have a specific number of Unicode code points. 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 equals the requirement, you can use message to customize the error message.

Returns

• Action NotCodePointsAction<TInput, TRequirement, TMessage>

Examples

The following examples show how notCodePoints can be used.

Not code points schema

Schema to validate a string with more or less than 8 code points.

const NotCodePointsSchema = v.pipe(
  v.string(),
  v.notCodePoints(8, 'The string must not have 8 code points.')
);

Related

The following APIs can be combined with notCodePoints.

Schemas

any, custom, string

Methods

pipe

Actions

notGraphemes, notLength

Utils

isOfKind, isOfType