Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More

email-misspelled

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

email-misspelled

Check misspell email's domain and return a list of matching domain suggestions


Version published
Weekly downloads
9.3K
increased by36.69%
Maintainers
1
Weekly downloads
 
Created

email-misspelled

Lightweight 4ko lib


CircleCI Status codecov npm npm npm


Check misspell email's domain and return a list of matching domain suggestions

String comparison is based on this


live codepen demo


Install

npm i email-misspelled --save
or
yarn add email-misspelled


Importing

import emailMisspelled from "email-misspelled"

const emailChecker = emailMisspelled()

emailChecker("user@otmail.com")  
/**  
 * return :  
 * [{ suggest: "hotmail.com", misspelledCount: 1, corrected:"user@hotmail.com"}]
 **/


Options

maxMisspelled

TypeDefaultDescription
number2max possible misspelled
import emailMisspelled from "email-misspelled"
const emailChecker1 = emailMisspelled({ maxMisspelled: 1 })

emailChecker1("user@hotmial.com")  
/**  
 * return :  
 * [{ suggest: "hotmail.com", misspelledCount: 2, corrected:"user@hotmail.com"}]
 **/
emailChecker1("user@hotmia.com") // undefined

const emailChecker2 = emailMisspelled({ maxMisspelled: 3 })

emailChecker2("user@hotmial.com")  
/**  
 * return :  
 * [{ suggest: "hotmail.com", misspelledCount: 2, corrected:"user@hotmail.com"}]
 **/
emailChecker2("user@hotmia.com")  
/**  
 * return :  
 * [{ suggest: "hotmail.com", misspelledCount: 3, corrected:"user@hotmail.com"}]
 **/
emailChecker2("user@otmia.com") //4 misspelled, return undefined

domainList

TypeDefaultDescription
string[]Domain listlist of checked domains
import emailMisspelled from "email-misspelled"
const emailChecker1 = emailMisspelled({ domainList: ["random.org"] })

emailChecker1("user@hotmial.com") // undefined
emailChecker1("user@randmo.org")  
/**  
 * return :  
 * [{ suggest: "random.org", misspelledCount: 1, corrected:"user@random.org"}]
 **/

lengthDiffMax

TypeDefaultDescription
number2max length difference between two string
import emailMisspelled from "email-misspelled"
const emailChecker1 = emailMisspelled({ lengthDiffMax: 1 })

emailChecker1("user@otmail.com")  
/**  
 * return :  
 * [{ suggest: "hotmail.com", misspelledCount: 1, corrected:"user@hotmail.com"}]
 **/
emailChecker1("user@tmail.com") // undefined  

const emailChecker2 = emailMisspelled({ lengthDiffMax: 2 })

emailChecker2("user@otmail.com")  
/**  
 * return :  
 * [{ suggest: "hotmail.com", misspelledCount: 1, corrected:"user@hotmail.com"}]
 **/
emailChecker2("user@tmail.com")  
/**  
 * return :  
 * [
 *    { suggest: "gmail.com", misspelledCount: 1, corrected:"user@gmail.com"}
 *    { suggest: "hotmail.com", misspelledCount: 2, corrected:"user@hotmail.com"},
 * ]
 **/

Default domain list

  • gmail.com
  • yahoo.com
  • hotmail.com
  • aol.com
  • hotmail.co.uk
  • hotmail.fr
  • msn.com
  • yahoo.fr
  • wanadoo.fr
  • orange.fr
  • comcast.net
  • yahoo.co.uk
  • yahoo.com.br
  • yahoo.co.in
  • live.com
  • rediffmail.com
  • free.fr
  • gmx.de
  • web.de
  • yandex.ru
  • ymail.com
  • libero.it
  • outlook.com
  • uol.com.br
  • bol.com.br
  • mail.ru
  • cox.net
  • hotmail.it
  • sbcglobal.net
  • sfr.fr
  • live.fr
  • verizon.net
  • live.co.uk
  • googlemail.com
  • yahoo.es
  • ig.com.br
  • live.nl
  • bigpond.com
  • terra.com.br
  • yahoo.it
  • neuf.fr
  • yahoo.de
  • alice.it
  • rocketmail.com
  • att.net
  • laposte.net
  • facebook.com
  • bellsouth.net
  • yahoo.in
  • hotmail.es
  • charter.net
  • yahoo.ca
  • yahoo.com.au
  • rambler.ru
  • hotmail.de
  • tiscali.it
  • shaw.ca
  • yahoo.co.jp
  • sky.com
  • earthlink.net
  • optonline.net
  • freenet.de
  • t-online.de
  • aliceadsl.fr
  • virgilio.it
  • home.nl
  • qq.com
  • telenet.be
  • me.com
  • yahoo.com.ar
  • tiscali.co.uk
  • yahoo.com.mx
  • voila.fr
  • gmx.net
  • mail.com
  • planet.nl
  • tin.it
  • live.it
  • ntlworld.com
  • arcor.de
  • yahoo.co.id
  • frontiernet.net
  • hetnet.nl
  • live.com.au
  • yahoo.com.sg
  • zonnet.nl
  • club-internet.fr
  • juno.com
  • optusnet.com.au
  • blueyonder.co.uk
  • bluewin.ch
  • skynet.be
  • sympatico.ca
  • windstream.net
  • mac.com
  • centurytel.net
  • chello.nl
  • live.ca
  • aim.com
  • bigpond.net.au

TODO

  • Doc
  • TU
  • TS
  • Extend default domain list

FAQs

Package last updated on 06 Jun 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts