node-domexception - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

index.js

 /*! node-domexception. MIT License. Jimmy Wärting <https://jimmy.warting.se/opensource> */
 
-if (!globalThis.DOMException) {
-  try {
-    const { MessageChannel } = require('worker_threads'),
-    port = new MessageChannel().port1,
-    ab = new ArrayBuffer()
-    port.postMessage(ab, [ab, ab])
-  } catch (err) {
-    err.constructor.name === 'DOMException' && (
-      globalThis.DOMException = err.constructor
-    )
-  }
+const DOMException = globalThis.DOMException ??= (() => {
+  try { atob(0) } catch (err) { return err.constructor }
+})()
+
+export {
+  DOMException,
+  DOMException as default
 }
-
-module.exports = globalThis.DOMException

package.json

 {
   "name": "node-domexception",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "An implementation of the DOMException class from NodeJS",
   "main": "index.js",
+  "type": "module",
   "repository": {
@@ -11,3 +12,3 @@ "type": "git",
   "engines": {
-    "node": ">=10.5.0"
+    "node": ">=16"
   },
@@ -14,0 +15,0 @@ "author": "Jimmy Wärting",

README.md

 # DOMException
 An implementation of the DOMException class from NodeJS
 
-NodeJS has DOMException built in, but it's not globally available, and you can't require/import it from somewhere.
+NodeJS has DOMException built in (from v10.5), but it is not easily available... you can't require or import it from somewhere (unless you use node v17 - at which point it got added to global scope)
 
 This package exposes the [`DOMException`](https://developer.mozilla.org/en-US/docs/Web/API/DOMException) class that comes from NodeJS itself. (including all of the legacy codes)
 
-<sub>(plz don't depend on this package in any other environment other than node >=10.5)</sub>
+## Install
 
+```bash
+# esm-only (makes use of atob | require NodeJS 16+)
+npm install node-domexception
+
+# cjs (makes use of worker_thread | require NodeJS 10+)
+npm install node-domexception@1.x
+```
+
+v2.x now depend on global `atob` to obtain `DOMException` from a error.
+which also binds it to NodeJS v16+ (at which point `atob` become globally available).
+This NodeJS dependency free solution is better for cross env platform solutions.
+if you are stuck with cjs then you can only do async `import()` from cjs projects.
+
+v1.x used a older [tech](https://github.com/jimmywarting/node-domexception/blob/c2024740c6502f80ad2f62c8ad58d6cec61b05f3/index.js) which depended on `node:worker_threads` to obtain
+`DOMException` which works all the way down to v10.5
+v1.x was also written in cjs, so if you want to support NodeJS v10.5+ or can't
+use ESM then install v1.x
+
+If are not supporting older NodeJS versions (before v17) then you won't need this package at all.
+My personal recommendation is that you update to a newer NodeJS version.
+
 ```js
-import DOMException from 'node-domexception'
+import { DOMException } from 'node-domexception'
+
+// it also act as a pollyfill (so you can use globalThis.DOMException)
+import 'node-domexception'
+
+// You could also do conditional import.
+globalThis.DOMException || await import('node-domexception')
+
+/********************************************************************/
+
 import { MessageChannel } from 'worker_threads'
 
-async function hello() {
+try {
   const port = new MessageChannel().port1
   const ab = new ArrayBuffer()
   port.postMessage(ab, [ab, ab])
-}
-
-hello().catch(err => {
+} catch (err) {
   console.assert(err.name === 'DataCloneError')
   console.assert(err.code === 25)
-  console.assert(err instanceof DOMException)
-})
+  console.assert(err.constructor === DOMException)
+}
 
@@ -39,5 +67,5 @@ const e1 = new DOMException('Something went wrong', 'BadThingsError')
 
-The only possible way is to use some web-ish tools that have been introduced into NodeJS that throws a DOMException and catch the constructor. This is exactly what this package dose for you and exposes it.<br>
+The only possible way is to use some web-ish tools that have been introduced into NodeJS that throws a DOMException and catch the constructor. This is exactly what this package does for you and exposes it.<br>
 This way you will have the same class that NodeJS has and you can check if the error is a instance of DOMException.<br>
-The instanceof check would not have worked with a custom class such as the DOMException provided by domenic which also is much larger in size since it has to re-construct the hole class from the ground up.
+The instanceof check would not have worked with a custom class such as the DOMException provided by domenic which also is much larger in size since it has to re-construct the whole class from the ground up.
 
@@ -44,0 +72,0 @@ The DOMException is used in many places such as the Fetch API, File & Blobs, PostMessaging and more. <br>

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

75

increased by59.57%

Is type module

Yes

Worsened metrics

Total package byte prevSize

5411

decreased by-81.45%

Number of package files

5

decreased by-88.1%

Lines of code

8

decreased by-98.32%

Number of medium supply chain risk alerts

2

increased byInfinity%

No dependency changes