fakeout 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 burnr contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,51 @@
1
+ # fakeout
2
+
3
+ [![npm version](https://img.shields.io/npm/v/fakeout.svg)](https://www.npmjs.com/package/fakeout)
4
+ [![license](https://img.shields.io/npm/l/fakeout.svg)](./LICENSE)
5
+
6
+ Detect disposable (burner) email domains. Zero dependencies, auto-updated dataset.
7
+
8
+ ## Install
9
+
10
+ ```bash
11
+ npm install fakeout
12
+ ```
13
+
14
+ ## Usage
15
+
16
+ ```ts
17
+ import { isDisposableEmail, isDisposableDomain, getDisposableDomains } from "fakeout";
18
+
19
+ isDisposableEmail("user@mailinator.com"); // true
20
+ isDisposableEmail("user@gmail.com"); // false
21
+ isDisposableEmail("not-an-email"); // false
22
+
23
+ isDisposableDomain("guerrillamail.com"); // true
24
+ isDisposableDomain("outlook.com"); // false
25
+
26
+ const domains = getDisposableDomains(); // string[] — sorted, ~5000+ entries
27
+ ```
28
+
29
+ ## API
30
+
31
+ ### `isDisposableEmail(email: string): boolean`
32
+
33
+ Returns `true` if the email's domain is a known disposable email provider. Returns `false` for invalid emails.
34
+
35
+ ### `isDisposableDomain(domain: string): boolean`
36
+
37
+ Returns `true` if the bare domain is in the disposable blocklist. Handles uppercase and whitespace.
38
+
39
+ ### `getDisposableDomains(): string[]`
40
+
41
+ Returns a sorted array of all known disposable domains. Each call returns a new copy.
42
+
43
+ ## How it works
44
+
45
+ The domain dataset is sourced from [disposable-email-domains](https://github.com/disposable-email-domains/disposable-email-domains) and compiled into a `Set<string>` at build time — no file I/O at runtime.
46
+
47
+ A GitHub Actions cron job syncs the upstream list daily. When domains change, tests run automatically and a new patch version is published to npm via [semantic-release](https://github.com/semantic-release/semantic-release).
48
+
49
+ ## License
50
+
51
+ MIT
@@ -0,0 +1,2 @@
1
+ export declare const DISPOSABLE_DOMAINS: ReadonlySet<string>;
2
+ //# sourceMappingURL=domains.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"domains.d.ts","sourceRoot":"","sources":["../src/domains.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC,MAAM,CAmlKjD,CAAC"}