@faykah/emails-en
v0.1.1
Published
Emails data set in English.
Downloads
6
Readme
@faykah/emails-en
Emails data set in English.
Summary
About
Faykah is a Node.js library that help create generators for various data.
This library contains a data set of English emails suited for mocking and testing emails.
Features
- Provides a variables containing 114 emails for testing purposes
- Provides a browser version
- Provides its own Typescript types
Installation
Using NPM:
npm install --save-dev @faykah/emails-enUsing Yarn:
yarn add --dev @faykah/emails-enExamples
1. Create an array generator
In this example, we will use @faykah/core to create an email generator, which will then let us generate random emails.
ES6
import { createArrayGenerator } from "@faykah/core";
import { emails } from "@faykah/emails-en";
const generateEmail = createArrayGenerator(emails);
generateEmail(); // "[email protected]"
generateEmail(); // "[email protected]"CJS
const { createArrayGenerator } = require("@faykah/core");
const { emails } = require("@faykah/emails-en");
const generateEmail = createArrayGenerator(emails);
generateEmail(); // "[email protected]"
generateEmail(); // "[email protected]"Browser
<body>
<script type="text/javascript" src="https://unpkg.com/@faykah/[email protected]/lib/index.browser.min.js" defer></script>
<script type="text/javascript" src="https://unpkg.com/@faykah/[email protected]/lib/index.browser.min.js" defer></script>
<script type="text/javascript" defer>
const generateEmail = Faykah.createArrayGenerator(Faykah.emails);
generateEmail(); // "[email protected]"
generateEmail(); // "[email protected]"
</script>
</body>2. Standalone usage
In this example, we will simply loop over the emails to understand you what it contains.
ES6
import { emails } from "@faykah/emails-en";
for (const email of emails) {
console.log(email);
}CJS
const { emails } = require("@faykah/emails-en");
for (const email of emails) {
console.log(email);
}Browser
<body>
<script type="text/javascript" src="https://unpkg.com/@faykah/[email protected]/lib/index.browser.min.js" defer></script>
<script type="text/javascript" defer>
for (const email of Faykah.emails) {
console.log(email);
}
</script>
</body>