this repo has no description
README updated
+41
+41
README.md
+41
README.md
···
1
+
# Disposable Email Detector
2
+
3
+
[](https://codescene.io/projects/50926)
4
+
5
+
[](https://www.bestpractices.dev/projects/8456)
6
+
7
+
8
+
## Overview
9
+
10
+
The `disposable-email-detector` is a TypeScript utility designed to identify disposable email addresses, providing developers with a tool to enhance email verification processes.
11
+
12
+
## Features
13
+
14
+
- **Domain Check:** Identifies if an email address belongs to a known disposable email domain.
15
+
- **Error Handling:** Offers informative messages for scenarios like missing `index.json` or invalid JSON format.
16
+
- **Async File Reading:** Utilizes asynchronous file reading for improved performance.
17
+
18
+
## Getting Started
19
+
20
+
### Prerequisites
21
+
22
+
- Node.js
23
+
- npm
24
+
25
+
### Installation
26
+
27
+
1. Clone the repository.
28
+
2. Install dependencies:
29
+
30
+
```bash
31
+
npm install
32
+
33
+
### Implementation Details
34
+
35
+
The disposableEmailDetector function reads a list of disposable email domains from index.json. It checks whether the provided email address belongs to a disposable domain and returns a boolean indicating the result.
36
+
37
+
### Error Handling
38
+
39
+
If index.json is not found, the script informs you to create it with disposable domains.
40
+
If index.json has an invalid JSON format, it prompts you to correct the file.
41
+
Unexpected errors are logged to the console.