email

Создаёт действие для проверки адреса электронной почты.

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

Обобщённые типы

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

Параметры

• message TMessage

Объяснение

С помощью email можно проверить формат строки. Если введённое значение не является адресом электронной почты, для настройки сообщения об ошибке можно использовать message.

Это действие намеренно проверяет только распространённые адреса электронной почты. Если вам нужно действие, охватывающее более широкое подмножество адресов RFC 5322, используйте действие rfcEmail.

Возвращаемое значение

• Action EmailAction<TInput, TMessage>

Примеры

В следующих примерах показано, как можно использовать 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.')
);

Схема необязательного адреса электронной почты

Схема для проверки адреса электронной почты, допускающая пустую строку, например для необязательного поля формы.

const OptionalEmailSchema = v.optional(
  v.union([
    v.literal(''),
    v.pipe(v.string(), v.email('The email is badly formatted.')),
  ]),
  ''
);

Связанные API

Следующие API можно использовать вместе с email.

Схемы

any, custom, string

Методы

pipe

Утилиты

isOfKind, isOfType