@zootools/email-spell-checker
Advanced tools
Comparing version 1.5.0 to 1.6.0
{ | ||
"private": false, | ||
"name": "@zootools/email-spell-checker", | ||
"version": "1.5.0", | ||
"version": "1.6.0", | ||
"description": "mailSpellChecker.js (mail spell checker) is a lightweight module that suggests a right domain when your users misspell it in an email address", | ||
@@ -133,3 +133,6 @@ "main": "./dist/index.js", | ||
] | ||
}, | ||
"dependencies": { | ||
"js-levenshtein": "1.1.6" | ||
} | ||
} |
@@ -12,3 +12,3 @@ <p align="center"> | ||
<p align="center"> | ||
<b>Email Spell Checker</b> is the <strong>easiest way to reduce misspelled email addresses in your web apps and server</strong>. Used in production daily by top companies to validate thousands of mispelled emails. | ||
<b>EmailSpellChecker</b> is the <strong>easiest way to reduce misspelled email addresses in your web apps and server</strong>. Used in production daily by top companies to validate thousands of mispelled emails. | ||
</p> | ||
@@ -22,3 +22,3 @@ </a> | ||
# @zootools/email-spell-checker | ||
## @zootools/email-spell-checker | ||
@@ -30,5 +30,5 @@ [![npm package][npm-img]][npm-url] | ||
<b>Email Spell Checker</b> is a lightweight JavaScript module written in TypeScript that suggests a right domain when your users misspell it in an email address. | ||
<b>EmailSpellChecker</b> is a lightweight JavaScript module written in TypeScript that suggests a right domain when your users misspell it in an email address. | ||
At [ZooTools - web3 mailchimp alternative](https://zootools.co), we validate thousands of emails daily with _email-spell-checker_ and it helped us to reducing bounced emails by 30%. | ||
At [ZooTools - web3 mailchimp alternative](https://zootools.co), we validate thousands of emails daily with _EmailSpellChecker_ and it helped us to reducing bounced emails by 30%. | ||
@@ -40,4 +40,4 @@ ## The features your deserve | ||
- ⚡️ <b>Lighting fast</b>: Highly performance email checking using `Sift3` - a fast and accurate string distance algorithm. | ||
- 🚀 <b>Ridiculously small</b>: 2KB (minzip) and 0 external dependencies. We agree, big bundles suck! | ||
- 🔋 <b>Updated</b>: 39+ popular domains, and 66+ modern TLDs out-of-the-box. Frequent updates. | ||
- 🔋 <b>Updated</b>: 39+ popular domains, and 66+ modern TLDs out-of-the-box. Frequently updated. | ||
- 🚀 <b>Ridiculously small</b>: 0.5KB (minzip) and 0 external dependencies. We agree, big bundles suck! | ||
- 💙 <b>TypeScript</b>: Fully written in TypeScript, cause we know you love it and we too. | ||
@@ -48,4 +48,8 @@ - ⚙️ <b>Extensible</b>: Allows to pass your custom rules and domains. Tweak it as you need. | ||
## Some good use cases | ||
## Why should you validate emails spelling? | ||
Typos in the email will harm your business. Specially email deliverability. Common user mispellings such as “gnail” instead of “gmail” or “yaho” instead of “yahoo” can be used as [spam traps](https://sendgrid.com/blog/spam-traps-what-they-are-and-why-you-should-pay-attention-to-them/) by ISPs, and as a result, your emails will be blocked or marked as spam. | ||
Common use cases: | ||
- User authentication (login, signup, email recovery). | ||
@@ -57,3 +61,3 @@ - Backend email validation. | ||
Adding Email Spell Checker to your project takes you less than 5 minutes. | ||
Adding <b>EmailSpellChecker</b> to your project takes less than 5 minutes. | ||
@@ -113,3 +117,3 @@ It works on any JavaScript framework (Vue, React, Next.JS, Angular, Svelte, etc) as well as the your backend server. | ||
EmailSpellChecker has inbuilt defaults if the `domains`, `secondLevelDomains` or `topLevelDomains` options aren't provided. | ||
<b>EmailSpellChecker</b> has inbuilt defaults if the `domains`, `secondLevelDomains` or `topLevelDomains` options aren't provided. | ||
@@ -142,3 +146,3 @@ The out-of-the-box configuration is the best for 99% of cases. If you are that 1%, here is how you can extend the configuration :). | ||
Tweet [@ZooToolsHQ](https://twitter.com/ZooToolsHQ) and [@JGFerreiro](https://twitter.com/JGFerreiro) if you are interested to appear. | ||
Tweet us [@ZooToolsHQ](https://twitter.com/ZooToolsHQ) and [@JGFerreiro](https://twitter.com/JGFerreiro) if you are interested to appear. | ||
@@ -149,7 +153,10 @@ | ||
* 🎯 Major updates: [Join our mailing lists to get useful information](https://form.waitlistpanda.com/go/8H98mVOzZhwGMalf8nfb) about this and other useful open source libraries: https://form.waitlistpanda.com/go/8H98mVOzZhwGMalf8nfb | ||
* 📆 Updates: Click "Watch repo" on Github and ⭐️ the repo to get useful information. | ||
* 🤝 Do you have bugs or issues? Email [github@zootools.co](github@zootools.co) and create an [create an issue](https://github.com/zootools/email-spell-checker/issues) | ||
Updates | ||
* 🎯 [Join our mailing lists to get useful information](https://form.waitlistpanda.com/go/8H98mVOzZhwGMalf8nfb) about this and other useful open source libraries: https://form.waitlistpanda.com/go/8H98mVOzZhwGMalf8nfb | ||
* 📆 Click "Watch repo" on Github and ⭐️ the repo to get useful information. | ||
Socials: | ||
Customer support | ||
* 🤝 Do you have bugs or issues? Email [github@zootools.co](github@zootools.co) and [create an issue](https://github.com/zootools/email-spell-checker/issues) | ||
Socials | ||
* [@ZooToolsHQ](https://twitter.com/ZooToolsHQ) | ||
@@ -167,2 +174,16 @@ * [@EmailSpellChecker](https://twitter.com/EmailSpellChecker) | ||
## We're hiring! | ||
Badass developer looking for a job? [Join the grind](https://www.notion.so/zootools/Careers-at-ZooTools-2e2815794b14415daca297506c54cb69)! | ||
<p> | ||
<a href="https://zootools.co"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="https://open-source.zootools.co/made_with_love.png?raw=true"> | ||
<img src="https://open-source.zootools.co/made_with_love.png?raw=true" height="80"> | ||
</picture> | ||
</a> | ||
</p> | ||
[downloads-img]: https://img.shields.io/npm/dt/@zootools/email-spell-checker?labelColor=475873&color=6ead0a | ||
@@ -169,0 +190,0 @@ [downloads-url]: https://www.npmtrends.com/@zootools/email-spell-checker |
32792
193
1
+ Addedjs-levenshtein@1.1.6
+ Addedjs-levenshtein@1.1.6(transitive)