From e5e33df2bff7ea26f5d73e64c3e72f2effa3e44f Mon Sep 17 00:00:00 2001
From: Henrique <henriquecfreitas@hotmail.com.br>
Date: Fri, 11 Aug 2023 12:08:33 -0300
Subject: [PATCH] Implementing module declaration file

---
 index.d.ts | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 index.d.ts

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<string>,
+  blacklist: Array<string>,
+  allowFreemail: boolean,
+  allowDisposable: boolean
+}
+
+type ErrorKind = "invalid" | "disposable" | "freemail" | "blacklisted"
+
+type CheckReturn = {
+  email: string,
+  domain: string,
+  valid: boolean,
+  errors: Array<ErrorKind>,
+  typo?: string
+}
+
+declare class EmailValidation {
+  constructor(options?: Partial<EmailValidationOptions>);
+  check(email: string): CheckReturn;
+  whitelist(domain: string): void;
+  blacklist(domain: string): void;
+  setOptions(options: Partial<EmailValidationOptions>): void;
+}
+
+export default EmailValidation;
+