@twilio/flex-ui/src/core/EmailUtils.d.ts

Twilio Flex UI

/**
 * Validates an email address.
 * @param {string} email - The email address to validate.
 * @returns {boolean} true if the email is valid, false otherwise.
 * @example
 * // Example usage with valid email:
 * const isValid1 = isValidEmail("test@example.com");
 * console.log(isValid1); // true
 *
 * // Example usage with another valid email:
 * const isValid2 = isValidEmail("john.doe@email.co");
 * console.log(isValid2); // true
 * @example
 * // Example usage with invalid email (missing "@" symbol):
 * const isValid3 = isValidEmail("notanemail");
 * console.log(isValid3); // false
 *
 * // Example usage with invalid email (missing domain):
 * const isValid4 = isValidEmail("john.doe@");
 * console.log(isValid4); // false
 *
 * // Example usage with invalid email (empty domain):
 * const isValid5 = isValidEmail("john.doe@.com");
 * console.log(isValid5); // false
 */
export declare const isValidEmail: (email: string) => boolean;