email

Creates an email validation action.

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

Generics

Parameters

  • message TMessage

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.

This validation action intentionally only validates common email addresses. If you are interested in an action that covers the entire specification, please see issue #204.

Returns

Examples

The following examples show how email can be used.

Email schema

Schema to validate an email.

const EmailSchema = v.pipe(
  v.string(),
  v.nonEmpty('Please enter your email.'),
  v.email('The email is badly formatted.'),
  v.maxLength(30, 'Your email is too long.')
);

The following APIs can be combined with email.

Schemas

Methods

Utils

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of Thanaen
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of F0rce
  • GitHub profile picture of caegdeveloper