Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 1.47 KB

README.md

File metadata and controls

77 lines (49 loc) · 1.47 KB

usevalid.email

Node.js build and publish package Running Code Coverage

Validate Your Emails with Confidence

Getting started

Installation

You can install the package via npm:

npm install @usevalid-email/js-sdk

Or yarn:

yarn add @usevalid-email/js-sdk

Or Bun.js:

bun add @usevalid-email/js-sdk

Usage

// using Sdk
import Sdk from '@usevalid-email/js-sdk';

const sdk = new Sdk('your-api-key');
const validator = sdk.validator;

const email = 'test@gmail.com';

validator.validate(email).then((response) => {
  console.log(response);
});

or

// using useValidEmail
import { useValidEmail } from '@usevalid-email/js-sdk';

const validator = useValidEmail('your-api-key');

const email = 'test@gmail.com';

validator.validate(email).then((response) => {
  console.log(response);
});

Testing

npm run test

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.