1 | # email-validator
|
2 | A simple module to validate an e-mail address
|
3 |
|
4 | [![travis build](https://img.shields.io/travis/manishsaraan/email-validator.svg?style=flat-square)](https://travis-ci.org/manishsaraan/email-validator)
|
5 | [![version](https://img.shields.io/npm/v/email-validator.svg?style=flat-square)]((http://npm.im/email-validator))
|
6 | [![downloads](https://img.shields.io/npm/dm/email-validator.svg?style=flat-square)](https://npm-stat.com/charts.html?package=email-validators&from=2015-08-01)
|
7 | [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg?style=flat-square)](https://github.com/xojs/xo)
|
8 |
|
9 | ## Installation
|
10 | Install via NPM:
|
11 |
|
12 | ```bash
|
13 | npm install email-validator
|
14 |
|
15 | ```
|
16 |
|
17 | ## Usage
|
18 |
|
19 | #### javascript
|
20 |
|
21 | ```javascript
|
22 |
|
23 | var validator = require("email-validator");
|
24 |
|
25 | validator.validate("test@email.com"); // true
|
26 |
|
27 | ```
|
28 |
|
29 | #### TypeScript
|
30 |
|
31 | ```typescript
|
32 |
|
33 | import * as EmailValidator from 'email-validator';
|
34 |
|
35 | EmailValidator.validate("test@email.com"); // true
|
36 |
|
37 |
|
38 | ```
|
39 |
|
40 | ## Contribute
|
41 |
|
42 | Contributions welcome! Check the ``LICENSE`` file for more info.
|
43 |
|
44 | ## Meta
|
45 |
|
46 | * robert@cosmicrealms.com
|
47 | * manish021js@gmail.com
|
48 |
|
49 | Distributed under the unlicense public domain. See ``LICENSE`` for more information.
|
50 |
|
51 | [https://github.com/manishsaraan/email-validator](https://github.com/manishsaraan/email-validator)
|