@helios-interactive/babbler

Babbler

Minimal email domain spellchecker. Calculates Levenshtein distance to included list of domains for errors. Returns the most relevant match.

Install

npm i -S babbler

Plain Jane

<script src="./node_modules/babbler/dist/babbler.min.js"></script>

CommonJS

const Babbler = require('babbler');

AMD

define(['babbler'], function(Babbler){

});

ES6

import Babbler from './node_modules/babbler/src/index.js'

Usage

Check

Check if the email is spelled correctly. Returns the closest match.

Incorrect spelling

Babbler.Check('[e-mail]');
// {suggestion: '[e-mail]', domain: 'gmail.com' distance: 1}

Correct spelling

Babbler.Check('[e-mail]');
// true

Invalid email address

Babbler.Check('michaelgmail.com');
// false

Domains

Append, overwrite, or get the domains list babbler checks against.

Append

Babbler.Domains(['something.co']);

Overwrite

Babbler.Domains(['something.co'], true);

Get

Babbler.Domains();