UNPKG

1.24 kBMarkdownView Raw
1# email-validator
2> A simple module to validate an e-mail address
3
4[![npm version](https://badge.fury.io/js/email-validator.svg)](https://badge.fury.io/js/email-validator)
5[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)]()
6
7## Installation
8Install via NPM:
9
10```ruby
11npm install email-validator
12
13```
14
15## Usage
16
17#### javascript
18
19```javascript
20
21var validator = require("email-validator");
22
23validator.validate("test@email.com"); // true
24
25validator.validate_async("test@email.com", function(err, isValidEmail) {
26 //Do something with isValidEmail
27}); // true
28
29```
30
31#### TypeScript
32
33```typescript
34
35import * as EmailValidator from 'email-validator';
36
37EmailValidator.validate("test@email.com"); // true
38
39EmailValidator.validate_async("test@email.com", ((err, isValidEmail) => {
40 // Do something with isValidEmail
41}));
42
43```
44
45## Contribute
46
47We would love for you to contribute to **email-validator**, check the ``LICENSE`` file for more info.
48
49## Meta
50
51Robert Schultz – http://cosmicrealms.com – robert@cosmicrealms.com
52
53Distributed under the MIT license. See ``LICENSE`` for more information.
54
55[https://github.com/Sembiance/email-validator](https://github.com/Sembiance/email-validator)