Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 2.51 KB

README.md

File metadata and controls

64 lines (48 loc) · 2.51 KB
Raw

Academic Email Verifier

Identifies email addresses or domains names that belong to colleges or universities. Retrieves institution name and owner role (i.e. faculty, student) if available. 🌌 Service Demo.

licence npm version

Installation

npm install --save academic-email-verifier

Usage

Import library:

import { Verifier } from 'academic-email-verifier';

Verify academic email address asynchronically:

// check if email address is a valid academic email address
let isAcademic = await Verifier.isAcademic('benny@stanford.edu');

Get full institution name asynchronically:

// get full institution name
let institutionName = await Verifier.getInstitutionName('megidish@mit.edu');

Supported Environments

  • 🖥 Node.js

Documentation

Support

If you're having any problem, please raise an issue on GitHub and we'll be happy to help.

Contribute

Before submitting a pull request, please make sure that you include tests, and that jshint runs without any warnings: Download VSCode extension.

Test

Run the test suite by executing:

$ npm test

Attribution

The database of this project is based on the ruby gem swot database. this database constitutes a significant part of this project.

Author: Benny Megidish.