email-misspelled
Advanced tools
Check misspell email's domain and return a list of matching domain suggestions
Lightweight < 3ko lib
Check the misspelled email's domain and return a list of matching domain suggestions sorted by corrections needed
The string comparison is based on this algorithm
Install with npm:
npm i email-misspelled --save
Install with yarn:
yarn add email-misspelled
import emailMisspelled, { top100 } from "email-misspelled"
const emailChecker = emailMisspelled({ domains: top100 })
emailChecker("user@otmail.com")
/**
* [{
* suggest: "hotmail.com",
* misspelledCount: 1,
* corrected:"user@hotmail.com",
* original: "user@otmail.com"
* }]
**/
Returned object model
Result
Result = {
/** suggested domain */
suggest: string
/** corrected email */
corrected: string
/** number correction needed */
misspelledCount: number
/** original email */
original: string
}[]
domains | Type | Required | Description |
|---|---|---|
string[] DomainList | true | list of domains to compare |
import emailMisspelled from "email-misspelled"
const emailChecker = emailMisspelled({ domains: ["random.org"] })
emailChecker("user@hotmial.com") // []
emailChecker("user@randmo.org")
/**
* return :
* [{
* suggest: "random.org",
* misspelledCount: 1,
* corrected:"user@random.org",
* original: "user@randmo.org"
* }]
**/
List of domains avaibles :
examples
import { top100, hotmail, live } from "email-misspelled"
or
import { top100, hotmail, live } from "email-misspelled/domains"
//etc
or
import top100 from "email-misspelled/domains/popular"
import hotmail from "email-misspelled/domains/hotmail"
import live from "email-misspelled/domains/live"
//etc
Feel free to contribute
maxMisspelled | Type | Required | Default | Description |
|---|---|---|---|
number | false | 2 | max possible misspelled |
import emailMisspelled, { top100 } from "email-misspelled"
const emailChecker1 = emailMisspelled({ maxMisspelled: 1, domains: top100 })
emailChecker1("user@hotmial.com")
/**
* return :
* [{
* suggest: "hotmail.com",
* misspelledCount: 1,
* corrected:"user@hotmail.com",
* original: "user@hotmial.com"
* }]
**/
emailChecker1("user@hotmia.com") // []
const emailChecker2 = emailMisspelled({ maxMisspelled: 3, domains: top100 })
emailChecker2("user@hotmial.com")
/**
* return :
* [{
* suggest: "hotmail.com",
* misspelledCount: 2,
* corrected:"user@hotmail.com",
* original: "user@hotmial.com"
* }]
**/
emailChecker2("user@hotmia.com")
/**
* return :
* [{
* suggest: "hotmail.com",
* misspelledCount: 3,
* corrected:"user@hotmail.com",
* original: "user@hotmia.com"
* }]
**/
emailChecker2("user@otmia.com") //4 misspelled, return []
lengthDiffMax | Type | Required | Default | Description |
|---|---|---|---|
number | false | 3 | max length difference between two string |
import emailMisspelled, { top100 } from "email-misspelled"
const emailChecker1 = emailMisspelled({ lengthDiffMax: 1, domains: top100 })
emailChecker1("user@otmail.com")
/**
* return :
* [{
* suggest: "hotmail.com",
* misspelledCount: 1,
* corrected:"user@hotmail.com",
* original: "user@otmail.com"
* }]
**/
emailChecker1("user@tmail.com") // []
const emailChecker2 = emailMisspelled({ lengthDiffMax: 2, domains: top100 })
emailChecker2("user@otmail.com")
/**
* return :
* [{
* suggest: "hotmail.com",
* misspelledCount: 1,
* corrected:"user@hotmail.com",
* original: "user@otmail.com"
* }]
**/
emailChecker2("user@tmail.com")
/**
* return :
* [{
* suggest: "gmail.com",
* misspelledCount: 1,
* corrected:"user@gmail.com",
* original: "user@tmail.com"
* },
* {
* suggest: "hotmail.com",
* misspelledCount: 2,
* corrected:"user@hotmail.com",
* original: "user@tmail.com"
* }]
**/
You can find Types and Interfaces under the /typings folder
DomainList
import { DomainList } from "email-misspelled/typings"
string[]
EmailMisspelledConstructor
import { EmailMisspelledConstructor } from "email-misspelled/typings"
(config: {
lengthDiffMax?: number;
maxMisspelled?: number;
domains: DomainList;
}): EmailMisspelled;
EmailMisspelled
import { EmailMisspelled } from "email-misspelled/typings"
(email: string): Result[]
Result
import { Result } from "email-misspelled/typings"
{
suggest: string;
corrected: string;
misspelledCount: number;
original: string;
}
ordered by number of existing email
gmail.comyahoo.comhotmail.comaol.comhotmail.co.ukhotmail.frmsn.comyahoo.frwanadoo.frorange.frcomcast.netyahoo.co.ukyahoo.com.bryahoo.co.inlive.comrediffmail.comfree.frgmx.deweb.deyandex.ruymail.comlibero.itoutlook.comuol.com.brbol.com.brmail.rucox.nethotmail.itsbcglobal.netsfr.frlive.frverizon.netlive.co.ukgooglemail.comyahoo.esig.com.brlive.nlbigpond.comterra.com.bryahoo.itneuf.fryahoo.dealice.itrocketmail.comatt.netlaposte.netfacebook.combellsouth.netyahoo.inhotmail.escharter.netyahoo.cayahoo.com.aurambler.ruhotmail.detiscali.itshaw.cayahoo.co.jpsky.comearthlink.netoptonline.netfreenet.det-online.dealiceadsl.frvirgilio.ithome.nlqq.comtelenet.beme.comyahoo.com.artiscali.co.ukyahoo.com.mxvoila.frgmx.netmail.complanet.nltin.itlive.itntlworld.comarcor.deyahoo.co.idfrontiernet.nethetnet.nllive.com.auyahoo.com.sgzonnet.nlclub-internet.frjuno.comoptusnet.com.aublueyonder.co.ukbluewin.chskynet.besympatico.cawindstream.netmac.comcenturytel.netchello.nllive.caaim.combigpond.net.auFAQs
Check misspell email's domain and return a list of matching domain suggestions
The npm package email-misspelled receives a total of 7,547 weekly downloads. As such, email-misspelled popularity was classified as popular.
We found that email-misspelled demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
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.
Security News
Ransomware negotiators share how modern cybercriminals operate like corporations, using specialized teams, negotiation tactics, and reputation management.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.