regex

Creates a pipeline validation action that validates a string with a regex.

const Validation = regex<TInput>(requirement, message);

Generics

• TInput extends string

Parameters

• requirement RegExp
• message ErrorMessage | undefined

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.

Returns

• Validation RegexValidation<TInput>

Examples

The following examples show how regex can be used.

Pixel string schema

Schema to validate a pixel string.

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

Related

The following APIs can be combined with regex.

Schemas

• any,
• special,
• string,
• unknown