https://github.com/thedahoom/disposable-email
a lightweight, no dependencies, disposable email npm package with types forked from https://github.com/disposable/disposable
https://github.com/thedahoom/disposable-email
disposable-domains disposable-email disposable-email-blocker disposable-email-domains disposable-emails github-actions lightweight no-dependencies typescript updated
Last synced: about 1 month ago
JSON representation
a lightweight, no dependencies, disposable email npm package with types forked from https://github.com/disposable/disposable
- Host: GitHub
- URL: https://github.com/thedahoom/disposable-email
- Owner: TheDahoom
- License: other
- Created: 2023-07-19T00:07:59.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-25T18:02:10.000Z (about 1 year ago)
- Last Synced: 2024-04-26T02:43:46.132Z (about 1 year ago)
- Topics: disposable-domains, disposable-email, disposable-email-blocker, disposable-email-domains, disposable-emails, github-actions, lightweight, no-dependencies, typescript, updated
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@dahoom/disposable-email
- Size: 2.61 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Disposable email domains
> a simple, no dependencies, regularly updated disposable email npm package with types forked from https://github.com/disposable/disposable
[](https://github.com/Dahoom152/disposable-email/actions/workflows/node.js.yml)
[](https://img.shields.io/npm/v/@dahoom/disposable-email)
[](https://npmtrends.com/@dahoom152/disposable-email)
[](https://packagephobia.com/result?p=@dahoom/disposable-email)
[](https://img.shields.io/bundlephobia/minzip/%40dahoom%2Fdisposable-email)
```
npm i @dahoom/disposable-email
```
I recommend using this serverside to avoid malicious workarounds
## Examples
regular usage:
```
import disposable from "@dahoom/disposable-email";
const email = '[email protected]';
//returns true if the email is disposable, false if not
const temp = disposable.validate(email);
if(!temp){
return 'disposable emails are not allowed';
}
```
if you just want to import the function itself:
```
import { validate } from "@dahoom/disposable-email";
const email = '[email protected]';
//returns true if the email is disposable, false if not
const temp = validate(email);
if(!temp){
return 'disposable emails are not allowed';
}
```
## Description
| Function | Description |
| -------------------------------------------- | --------------------------------------------------------------------- |
| `validate(domainOrEmail, callback)` | Validates if a domain or email is disposable. |
| Parameter | Description |
| ------------- | ----------------------- |
| `domainOrEmail`| The domain or email to validate.|
| `callback` | The optional callback function to execute after validation.|
| Returns | Description |
| -------- | -------------------------------------------------------------------- |
| `boolean`| Returns true if the domain or email is not disposable, false otherwise.|
## Credits
Types included from [@types/disposable-email](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/disposable-email/index.d.ts)
Forked from https://github.com/disposable/disposable
A collection of domains for disposable email services like [10MinuteMail](http://10minutemail.com) and [GuerrillaMail](https://www.guerrillamail.com). Also, some 🛠to make your life easier.
- https://github.com/adamloving
- https://github.com/michenriksen
- https://github.com/ivolo