Skip to main content

Function: email()

email(errorMessage?): Validator<string, string, string>

Defined in: validation/validators/index.ts:130

Validates email address format.

Uses a simple but effective regex pattern for email validation.

Parameters​

errorMessage?​

string

Custom error message (optional)

Returns​

Validator<string, string, string>

Validator that checks email format

Example​

email()('john@example.com') // => Valid('john@example.com')
email()('invalid-email') // => Invalid(['Invalid email address'])
email('Bad email')('invalid') // => Invalid(['Bad email'])