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

Comparing version 1.8.1 to 1.8.2

dist/index.d.ts

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

dist/index.js

@@ -6,8 +6,6 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.POPULAR_DOMAINS = exports.run = void 0;
 const run_1 = __importDefault(require("./lib/run"));
+exports.run = run_1.default;
 const config_1 = require("./lib/config");
-const MailSpellChecker = {
-    run: run_1.default,
-    POPULAR_DOMAINS: config_1.POPULAR_DOMAINS,
-};
-exports.default = MailSpellChecker;
+Object.defineProperty(exports, "POPULAR_DOMAINS", { enumerable: true, get: function () { return config_1.POPULAR_DOMAINS; } });

package.json

 {
   "private": false,
   "name": "@zootools/email-spell-checker",
-  "version": "1.8.1",
+  "version": "1.8.2",
   "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

@@ -18,3 +18,3 @@ <p align="center">
 <p align="center">
-  <img src="assets/typesense_books_demo.gif?raw=true" alt="Typesense Demo" width="459" />
+  <img src="https://open-source.zootools.co/email-spell-checker/2022_10_22_demo_version_1.gif?raw=true" alt="Typesense Demo" width="459" />
 </p>
@@ -35,3 +35,3 @@
 
-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 that contains a [bug](https://github.com/ZooTools/email-spell-checker/pull/3).
+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).
 
@@ -86,5 +86,5 @@ - ⚡️ <b>Lighting fast</b>: Highly performance email checking using `Sift3` - a fast and accurate string distance algorithm.
 
-* Import it.
-* Call `run` function with the email you want to validate.
-* Get the suggested email, and prompt your user to accept suggestion.
+- Import it.
+- Call `run` function with the email you want to validate.
+- Get the suggested email, and prompt your user to accept suggestion.
 
@@ -111,4 +111,3 @@ ```js
 
-Extending Domains
--------
+## Extending Domains
 
@@ -119,3 +118,3 @@ <b>EmailSpellChecker</b> has inbuilt defaults if the `domains`, `secondLevelDomains` or `topLevelDomains` options aren't provided.
 
-#### Adding your own Domains ####
+#### Adding your own Domains
 
@@ -128,8 +127,7 @@ You can replace EmailSpellChecker's default domain/TLD suggestions by supplying replacements to `EmailSpellChecker.run`:
   secondLevelDomains: ['domain', 'yetanotherdomain'], // replaces existing SLDs
-  topLevelDomains: ['com.au', 'ru'] // replaces existing TLDs
+  topLevelDomains: ['com.au', 'ru'], // replaces existing TLDs
 });
 ```
 
-Tests
------
+## Tests
 
@@ -140,4 +138,3 @@ EmailSpellChecker is tested with [Jest](https://jestjs.io/), a popular JavaScript testing framework from Facebook with a focus on simplicity.
 
-Who uses EmailSpellChecker?
------------------------
+## Who uses EmailSpellChecker?
 
@@ -148,18 +145,19 @@ We're putting together a list of happy users of EmailSpellChecker.
 
+## Customer support & updates
 
-Customer support & updates
------------------------
-
 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.
 
+- 🎯 [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.
+
 Customer support
-* 🤝 Do you have bugs or issues? Email [[e-mail]]([e-mail]) and [create an issue](https://github.com/zootools/email-spell-checker/issues)
 
+- 🤝 Do you have bugs or issues? Email [[e-mail]]([e-mail]) and [create an issue](https://github.com/zootools/email-spell-checker/issues)
+
 Socials
-* [@ZooToolsHQ](https://twitter.com/ZooToolsHQ)
-* [@EmailSpellChecker](https://twitter.com/EmailSpellChecker)
-* [@JGFerreiro](https://twitter.com/JGFerreiro)
 
+- [@ZooToolsHQ](https://twitter.com/ZooToolsHQ)
+- [@EmailSpellChecker](https://twitter.com/EmailSpellChecker)
+- [@JGFerreiro](https://twitter.com/JGFerreiro)
+
 ## Maintainers
@@ -186,3 +184,2 @@
 
-
 [downloads-img]: https://img.shields.io/npm/dt/@zootools/email-spell-checker?labelColor=475873&color=6ead0a
@@ -189,0 +186,0 @@ [downloads-url]: https://www.npmtrends.com/@zootools/email-spell-checker

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

33527

increased by0.31%

Number of package files

34

increased by3.03%

Worsened metrics

Lines of code

625

decreased by-0.79%

Number of lines in readme file

190

decreased by-1.55%

No dependency changes