https://github.com/byteplant/email-validator-net
NodeJS wrapper for the email-validator.net API
https://github.com/byteplant/email-validator-net
byteplant cleaning cleaning-data data-quality data-validation email email-cleaning email-marketing email-validation email-verification javascript node-js node-module typescript validation verification
Last synced: about 2 months ago
JSON representation
NodeJS wrapper for the email-validator.net API
- Host: GitHub
- URL: https://github.com/byteplant/email-validator-net
- Owner: byteplant
- Created: 2016-02-18T12:26:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T00:38:42.000Z (over 2 years ago)
- Last Synced: 2024-04-14T22:19:12.330Z (about 1 year ago)
- Topics: byteplant, cleaning, cleaning-data, data-quality, data-validation, email, email-cleaning, email-marketing, email-validation, email-verification, javascript, node-js, node-module, typescript, validation, verification
- Language: TypeScript
- Homepage: https://www.email-validator.net/api.html
- Size: 468 KB
- Stars: 3
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# email-validator-net
A small library providing a wrapper for [api.email-validator.net](https://www.email-validator.net/api.html)
## Installation
```shell
npm install email-validator-net
# or
yarn add email-validator-net
```
## Usage
ES6 or TypeScript usage:
```js
import EmailValidator from 'email-validator-net'
// YOUR_API_KEY is a string
const validatorInstance = EmailValidator(YOUR_API_KEY)
// validatorInstance is a function and takes one argument
// argument must be a string
// validatorInstance returns a promise
const responseObject = await validatorInstance(EMAIL_TO_VALIDATE) // EMAIL_TO_VALIDATE is a string
// responseObject looks like this:
// {
// apiKey, // used apikey
// email, // validated email address
// statusCode, // statusCode of the service
// // => http://www.email-validator.net/email-verification-results.html
// statusString, // status as string
// fullResponse, // object with the full response from the service
// }
```
## Tests
```shell
yarn test
```
## Release History
- 2.0.0 Rewrite in Typescript and using Promises
- 0.1.0 Initial release