README

@faykah/emails-en

Emails data set in English.

Summary

About
Features
Installation
Examples

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-en

Using Yarn:

yarn add --dev @faykah/emails-en

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(); // "john.doe@example.com"
generateEmail(); // "foo@bar.com"

CJS

const { createArrayGenerator } = require("@faykah/core");
const { emails } = require("@faykah/emails-en");

const generateEmail = createArrayGenerator(emails);

generateEmail(); // "john.doe@example.com"
generateEmail(); // "foo@bar.com"

Browser

<body>
    <script type="text/javascript" src="https://unpkg.com/@faykah/core@0.1.0/lib/index.browser.min.js" defer></script>
    <script type="text/javascript" src="https://unpkg.com/@faykah/emails-en@0.1.0/lib/index.browser.min.js" defer></script>

    <script type="text/javascript" defer>
        const generateEmail = Faykah.createArrayGenerator(Faykah.emails);

        generateEmail(); // "john.doe@example.com"
        generateEmail(); // "foo@bar.com"
    </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);
}