regex

Creates a regex validation action.

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

Generics

• TInput extends string
• TMessage extends ErrorMessage<RegexIssue<TInput>> | undefined

Parameters

• requirement RegExp
• message TMessage

Explanation

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

Hint: Be careful with the global flag g in your regex pattern, as it can lead to unexpected results. See MDN for more information.

Returns

• Action RegexAction<TInput, TMessage>

Examples

The following examples show how regex can be used.

Pixel string schema

Schema to validate a pixel string.

const PixelStringSchema = v.pipe(
  v.string(),
  v.regex(/^\d+px$/, 'The pixel string is badly formatted.')
);

Related

The following APIs can be combined with regex.

Schemas

• any,
• custom,
• string,
• unknown

Methods

• pipe

Utils

• isOfKind,
• isOfType