email

Creates a pipeline validation action that validates an email.

const Validation = email<TInput>(message);

Generics

• TInput extends string

Parameters

• message ErrorMessage | undefined

Explanation

With email you can validate the formatting of a string. If the input is not an email, you can use message to customize the error message.

Returns

• Validation EmailValidation<TInput>

Examples

The following examples show how email can be used.

Email schema

Schema to validate an email.

const EmailSchema = string([
  minLength(1, 'Please enter your email.'),
  email('The email is badly formatted.'),
  maxLength(30, 'Your email is too long.'),
]);

Related

The following APIs can be combined with email.

Schemas

• any,
• special,
• string,
• unknown