# is-disposable

> A JavaScript library to check whether a email address is disposable.

Latest version **0.9.0** (published 2023-07-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-disposable
pnpm add is-disposable
yarn add is-disposable
bun add is-disposable
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.0 |
| Published | 2023-07-23 |
| First published | 2023-05-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18.0.0 |
| Dependencies | 0 |
| Unpacked size | 108.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Samuel Kopp |
| Maintainers | boywithkeyboard |

## Links

- npm: https://www.npmjs.com/package/is-disposable
- Repository: https://github.com/boywithkeyboard/is-disposable
- Homepage: https://github.com/boywithkeyboard/is-disposable#readme
- Issues: https://github.com/boywithkeyboard/is-disposable/issues
- Funding: https://github.com/sponsors/boywithkeyboard
- npm.io page: https://npm.io/package/is-disposable

## Recent versions

- 0.9.0 (latest) — 2023-07-23
- 0.8.0 — 2023-07-16
- 0.7.0 — 2023-07-09
- 0.6.0 — 2023-07-02
- 0.5.0 — 2023-06-25
- 0.4.0 — 2023-06-22
- 0.3.0 — 2023-06-04
- 0.2.0 — 2023-05-29
- 0.1.0 — 2023-05-29
- 0.0.0 — 2023-05-29

## README

## is-disposable

This library uses
[disposable-email-domains](https://github.com/disposable-email-domains/disposable-email-domains)
under the hood to check whether a email address is disposable.

---

**PROTIP:** If you need a more accurate solution, I recommend to check out my
upcoming cloud service [devyl](https://devyl.net).

---

### Setup

#### Deno

```ts
import isDisposable from 'https://deno.land/x/is_disposable@{VERSION}/mod.ts'
```

#### Node.js

```bash
npm i is-disposable
```

```ts
// ESM
import isDisposable from 'is-disposable'

// CommonJS
const isDisposable = require('is-disposable')
```

### Usage

```ts
// Offline Mode
console.log(await isDisposable('example@email.com')) // updated weekly

// Online Mode (RECOMMENDED)
console.log(await isDisposable('example@email.com', { remote: true })) // updated hourly
```

---
_Source: https://npm.io/package/is-disposable · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._