@fakerjs/email/README.md

Email package provides functionality to generate a fake email value.

<h1 align="center">Email</h1>
<p align="center">Email package provides functionality to generate a fake email value.</p>

<p align="center">
<a href="https://github.com/faker-javascript/email/releases"><img alt="Version" src="https://img.shields.io/github/release/faker-javascript/email.svg?label=version&color=green"></a> <img src="https://img.shields.io/npm/dt/@fakerjs/email"> <img alt="node-current" src="https://img.shields.io/node/v/@fakerjs/email"> <a href="https://github.com/faker-javascript/email/actions/workflows/ci.yml"><img src="https://github.com/faker-javascript/email/actions/workflows/ci.yml/badge.svg"></a> <a href="https://github.com/faker-javascript/email"><img src="https://img.shields.io/badge/license-MIT-blue.svg?color=green" alt="License"></a>
</p>

## Install

```
$ npm install --save @fakerjs/email
```

## Usage

```js
import email from '@fakerjs/email';

email();
//=> itiwuhilacupi@panetoc.services

email({domain: 'example.com'})
//=> rad@example.com
```

## Tests

Run tests

```
npm run test
```

## License
[The MIT License (MIT)](https://github.com/faker-javascript/email/blob/master/LICENSE)
Copyright (c) [Sergey Romanenko](https://github.com/Awilum)