@zootools/email-spell-checker - npm Package Compare versions

Comparing version 1.8.2 to 1.8.3

dist/index.d.ts

 import run from './lib/run';
 import { POPULAR_DOMAINS } from './lib/config';
+declare const MailSpellChecker: {
+    run: typeof run;
+    POPULAR_DOMAINS: string[];
+};
 export { run, POPULAR_DOMAINS };
+export default MailSpellChecker;

dist/index.js

@@ -11,1 +11,6 @@ "use strict";
 Object.defineProperty(exports, "POPULAR_DOMAINS", { enumerable: true, get: function () { return config_1.POPULAR_DOMAINS; } });
+const MailSpellChecker = {
+    run: run_1.default,
+    POPULAR_DOMAINS: config_1.POPULAR_DOMAINS,
+};
+exports.default = MailSpellChecker;

package.json

 {
   "private": false,
   "name": "@zootools/email-spell-checker",
-  "version": "1.8.2",
+  "version": "1.8.3",
   "description": "mailSpellChecker.js (mail spell checker) is a lightweight module that suggests a right domain when your users misspell it in an email address",
@@ -6,0 +6,0 @@ "main": "./dist/index.js",

README.md

 <p align="center">
-  <a href="https://zootools.co">
+  <a href="https://zootools.co/?ref=github-spell">
     <picture>
@@ -7,16 +7,24 @@ <source media="(prefers-color-scheme: dark)" srcset="https://open-source.zootools.co/email-spell-checker/logo_email-spell-checker.png?raw=true">
     </picture>
-    <p align="center">
-      🔐 Reduce failed authentication ⬆️ Increase emails delivery ⚡️ Built for speed
-    </p>
-    <h1 align="center">The best way to check a misspelled email address in JavaScript</h1>
-    <p align="center">
-      <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>
   </a>
 </p>
+<h1 align="center">The best way to check a misspelled email address in JavaScript</h1>
 
+<br/>
+
 <p align="center">
-  <img src="https://open-source.zootools.co/email-spell-checker/2022_10_22_demo_version_1.gif?raw=true" alt="Typesense Demo" width="459" />
+  🔐 Reduce failed authentication &nbsp;&nbsp;&nbsp;&nbsp; ⬆️ Increase emails delivery &nbsp;&nbsp;&nbsp;&nbsp; ⚡️ Built for speed
 </p>
 
+<br/>
+
+<p align="center">
+  <a href="https://zootools.co?ref=github-spell">
+    <kbd>
+    <img src="https://open-source.zootools.co/email-spell-checker/2022_10_22_demo_version_2_looped.gif?raw=true" alt="Did you say? The best email spell checker in JavaScript" width="700" style="border-radius: 10px;" />
+    </kbd>
+  </a>
+</p>
+
+<br/>
+
 ## @zootools/email-spell-checker
@@ -29,9 +37,11 @@
 
-<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.
+<b>EmailSpellChecker</b> is a lightweight JavaScript module written in TypeScript that suggests the 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 _EmailSpellChecker_ and it helped us to reducing bounced emails by 30%.
+At [ZooTools - web3 Mailchimp alternative](https://zootools.co?ref=github-spell), we validate thousands of misspelled emails daily with _EmailSpellChecker_ and it helped us to reduce bounced emails by 30%.
 
+It's by far the <strong>easiest way to reduce misspelled email addresses</strong> in your web apps and server.
+
 ## The features your deserve
 
-We rewrote and improved [mailcheck.js](https://github.com/mailcheck/mailcheck), a great module that is not longer maintained (7+ years since last update) and we fixed critical bugs like [this](https://github.com/ZooTools/email-spell-checker/pull/3), or [this](https://github.com/ZooTools/email-spell-checker/pull/4).
+We rewrote and improved [mailcheck.js](https://github.com/mailcheck/mailcheck), a great module that is no longer maintained (7+ years since the last update) and we fixed critical bugs like [this](https://github.com/ZooTools/email-spell-checker/pull/3), or [this](https://github.com/ZooTools/email-spell-checker/pull/4).
 
@@ -42,9 +52,9 @@ - ⚡️ <b>Lighting fast</b>: Highly performance email checking using `Sift3` - a fast and accurate string distance algorithm.
 - 💙 <b>TypeScript</b>: Fully written in TypeScript, cause we know you love it and we too.
-- ⚙️ <b>Extensible</b>: Allows to pass your custom rules and domains. Tweak it as you need.
-- 🔨 <b>1 minute migration</b>: Same API and functions as mailcheck so you can switch in a sec!
+- ⚙️ <b>Extensible</b>: Allows you to pass your custom rules and domains. Tweak it as you need.
+- 🔨 <b> 1-minute migration</b>: Same API and functions as mailcheck so you can switch in a sec!
 - 🔐 <b>Unit tested</b>: Cause we'd not ever used a library without tests :).
 
-## Why should you validate emails spelling?
+## Why should you validate email 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.
+Typos in the email will harm your business. Especially email deliverability. Common user misspellings 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.
 
@@ -57,2 +67,12 @@ Common use cases:
 
+## Tutorials
+
+Here are some highly-requested tutorials.
+
+- [🟨 JavaScript: Getting started in 5 minutes](#getting-started-in-5-minutes)
+- [🟦 React: Validating email spell in React](./docs/React.md)
+- [🟩 Node: Validating email spell in Node](./docs/Node.md)
+
+If you want to write a tutorial [send a PR](https://github.com/zootools/email-spell-checker/pulls) or [create an issue](https://github.com/zootools/email-spell-checker/issues) if you want to ask for one.
+
 ## Getting Started in 5 minutes
@@ -62,10 +82,4 @@
 
-It works on any JavaScript framework (Vue, React, Next.JS, Angular, Svelte, etc) as well as the your backend server.
+It works on any JavaScript framework (Vue, React, Next.JS, Angular, Svelte, etc) as well as your backend server.
 
-Here some highly-requested tutorials. If you want to write a tutorial [send a PR](https://github.com/zootools/email-spell-checker/pulls) or [create an issue](https://github.com/zootools/email-spell-checker/issues) if you want to ask for one:
-
-- JavaScript (Continue reading this README.md)
-- [⚛️ React: Validating email spell in React](./docs/React.md)
-- [✅ Node: Validating email spell in Node](./docs/Node.md)
-
 ### Installation
@@ -91,3 +105,3 @@
 - Call `run` function with the email you want to validate.
-- Get the suggested email, and prompt your user to accept suggestion.
+- Get the suggested email, and prompt your user to accept the suggestion.
 
@@ -149,3 +163,3 @@ ```js
 - 🎯 [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.
+- 📆 Click "Watch repo" on GitHub and ⭐️ the repo to be notified of useful information.
 
@@ -158,4 +172,4 @@ Customer support
 
+- [@EmailSpell](https://twitter.com/EmailSpell)
 - [@ZooToolsHQ](https://twitter.com/ZooToolsHQ)
-- [@EmailSpellChecker](https://twitter.com/EmailSpellChecker)
 - [@JGFerreiro](https://twitter.com/JGFerreiro)
@@ -167,5 +181,5 @@
 
-We use this library heavily in <a href="https://panda.zootools.co/">ZooTools Panda, a mailchimp alternative for sending viral marketing campaigns</a>.
+We use this library heavily in <a href="https://panda.zootools.co/?ref=github-spell">ZooTools Panda, a mailchimp alternative for sending viral marketing campaigns</a>.
 
-You can view examples of the use of this library <a href="https://panda.zootools.co/examples">here</a>
+You can view examples of the use of this library <a href="https://panda.zootools.co/examples?ref=github-spell">here</a>
 
@@ -172,0 +186,0 @@ ## We're hiring!

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

33999

increased by1.41%

Lines of code

635

increased by1.6%

Number of lines in readme file

204

increased by7.37%

No dependency changes