source: node_modules/node-domexception/README.md

main
Last change on this file was d24f17c, checked in by Aleksandar Panovski <apano77@…>, 15 months ago

Initial commit

  • Property mode set to 100644
File size: 2.0 KB
Line 
1# DOMException
2An implementation of the DOMException class from NodeJS
3
4NodeJS has DOMException built in, but it's not globally available, and you can't require/import it from somewhere.
5
6This 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)
7
8<sub>(plz don't depend on this package in any other environment other than node >=10.5)</sub>
9
10```js
11import DOMException from 'node-domexception'
12import { MessageChannel } from 'worker_threads'
13
14async function hello() {
15 const port = new MessageChannel().port1
16 const ab = new ArrayBuffer()
17 port.postMessage(ab, [ab, ab])
18}
19
20hello().catch(err => {
21 console.assert(err.name === 'DataCloneError')
22 console.assert(err.code === 25)
23 console.assert(err instanceof DOMException)
24})
25
26const e1 = new DOMException('Something went wrong', 'BadThingsError')
27console.assert(e1.name === 'BadThingsError')
28console.assert(e1.code === 0)
29
30const e2 = new DOMException('Another exciting error message', 'NoModificationAllowedError')
31console.assert(e2.name === 'NoModificationAllowedError')
32console.assert(e2.code === 7)
33
34console.assert(DOMException.INUSE_ATTRIBUTE_ERR === 10)
35```
36
37# Background
38
39The 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>
40This way you will have the same class that NodeJS has and you can check if the error is a instance of DOMException.<br>
41The 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.
42
43The DOMException is used in many places such as the Fetch API, File & Blobs, PostMessaging and more. <br>
44Why they decided to call it **DOM**, I don't know
45
46Please consider sponsoring if you find this helpful
Note: See TracBrowser for help on using the repository browser.