is-email-address/index.js

"use strict";

const ValidationError = require("@validatem/error");
const isString = require("@validatem/is-string");

let commonErrors = [
	/^mailto:.+$/, // mailto:email@example.com
	/^.+<[^>]+>$/, // Real Name <email@example.com>
];

module.exports = [
	isString,
	function isEmailAddress(value) {
		// TODO: Include explanation in README as to how checking for the presence of '@' really *is* the correct check in practice, and that any further validation should be done by actually trying to send an e-mail
		if (!value.includes("@") || commonErrors.some((errorRegex) => errorRegex.test(value))) {
			throw new ValidationError(`Must be an e-mail address`);
		}
	}
];