@devmehq/email-validator-js
Version:
Advanced email validation with MX records, SMTP verification, disposable email detection, batch processing, and caching. Production-ready with TypeScript support.
38 lines (37 loc) • 1.72 kB
TypeScript
import type { DomainSuggestion, ISuggestDomainParams } from './types';
/**
* List of common email domains for typo detection
* Includes popular free providers, business providers, and hosting services
*/
export declare const COMMON_EMAIL_DOMAINS: string[];
/**
* Default domain suggestion method using string similarity
*/
export declare function defaultDomainSuggestionMethod(domain: string, commonDomains?: string[]): DomainSuggestion | null;
/**
* Suggest a corrected domain for a potentially misspelled email domain
* @param params - Parameters including domain and optional custom method
* @returns Domain suggestion with confidence score, or null if no suggestion
*/
export declare function suggestDomain(params: ISuggestDomainParams): DomainSuggestion | null;
/**
* Convenience function to suggest domain from email address
* @param email - Email address to check for domain typos
* @param commonDomains - Optional list of common domains to check against
* @returns Domain suggestion with confidence score, or null if no suggestion
*/
export declare function suggestEmailDomain(email: string, commonDomains?: string[]): DomainSuggestion | null;
/**
* Check if a domain is in the common domains list
* @param domain - Domain to check
* @param commonDomains - Optional custom list of common domains
* @returns True if domain is common, false otherwise
*/
export declare function isCommonDomain(domain: string, commonDomains?: string[]): boolean;
/**
* Get similarity score between two domains
* @param domain1 - First domain
* @param domain2 - Second domain
* @returns Similarity score between 0 and 1
*/
export declare function getDomainSimilarity(domain1: string, domain2: string): number;