diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 0000000..95e01c2 --- /dev/null +++ b/index.d.ts @@ -0,0 +1,27 @@ +type EmailValidationOptions = { + whitelist: Array, + blacklist: Array, + allowFreemail: boolean, + allowDisposable: boolean +} + +type ErrorKind = "invalid" | "disposable" | "freemail" | "blacklisted" + +type CheckReturn = { + email: string, + domain: string, + valid: boolean, + errors: Array, + typo?: string +} + +declare class EmailValidation { + constructor(options?: Partial); + check(email: string): CheckReturn; + whitelist(domain: string): void; + blacklist(domain: string): void; + setOptions(options: Partial): void; +} + +export default EmailValidation; +