Title: doc: `DOMException` missing from “Errors” API reference docs page · Issue #40789 · nodejs/node · GitHub
Open Graph Title: doc: `DOMException` missing from “Errors” API reference docs page · Issue #40789 · nodejs/node
X Title: doc: `DOMException` missing from “Errors” API reference docs page · Issue #40789 · nodejs/node
Description: 📗 API Reference Docs Problem Version: v17.0.0 Platform: Linux 5.10.47-linuxkit x86_64 GNU/Linux Subsystem: errors Location Section of the site where the content exists Affected URL(s): https://nodejs.org/api/globals.html#domexception htt...
Open Graph Description: 📗 API Reference Docs Problem Version: v17.0.0 Platform: Linux 5.10.47-linuxkit x86_64 GNU/Linux Subsystem: errors Location Section of the site where the content exists Affected URL(s): https://node...
X Description: 📗 API Reference Docs Problem Version: v17.0.0 Platform: Linux 5.10.47-linuxkit x86_64 GNU/Linux Subsystem: errors Location Section of the site where the content exists Affected URL(s): https://node...
Opengraph URL: https://github.com/nodejs/node/issues/40789
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"doc: `DOMException` missing from “Errors” API reference docs page","articleBody":"# 📗 API Reference Docs Problem\r\n\r\n\u003c!--\r\n\r\nThank you for wanting to make nodejs.org better!\r\n\r\nThis template is for issues with the Node.js API\r\nreference documentation.\r\n\r\nFor problems with nodejs.org beyond the API\r\nreference documentation, please open an issue\r\nusing the issue tracker for our site repository.\r\n\r\n https://github.com/nodejs/nodejs.org\r\n\r\nFor more general support, please open an issue\r\nusing the issue tracker for our help repository.\r\n\r\n https://github.com/nodejs/help\r\n\r\n---\r\n\r\nFor the issue title, please enter a one-line\r\nsummary after “doc:” (preferably 50 characters\r\nor less and no more than 72).\r\n\r\nThe “✍️” are placeholders signifying requests for\r\ninput. Replace them with your responses.\r\n\r\nIf you are unsure of something, do your best.\r\n\r\n-->\r\n\r\n\u003c!-- The output of “node --version”. -->\r\n\r\n- **Version**: [v17.0.0](https://nodejs.org/en/blog/release/v17.0.0/)\r\n\r\n\u003c!-- The output of “uname -a” (UNIX) or version\r\nand 32-bit or 64-bit (Windows). -->\r\n\r\n- **Platform**: Linux 5.10.47-linuxkit x86_64 GNU/Linux\r\n\r\n\u003c!-- The name of affected core module. -->\r\n\r\n- **Subsystem**: `errors`\r\n\r\n## Location\r\n\r\n_Section of the site where the content exists_\r\n\r\nAffected URL(s):\r\n\r\n- https://nodejs.org/api/globals.html#domexception\r\n- https://nodejs.org/api/errors.html\r\n\r\n## Description\r\n\r\n_Concise explanation of the problem_\r\n\r\n\u003c!-- If applicable, include any screenshots that\r\nmay help solve the problem. -->\r\n\r\n[`DOMException`](https://webidl.spec.whatwg.org/#idl-DOMException), which was [made globally available](https://github.com/nodejs/node/issues/39098) in v17.0.0, is not amongst the runtime errors listed in our [“Errors” API reference docs](https://nodejs.org/dist/latest-v17.x/docs/api/errors.html). \r\n\r\nIt is, however, correctly listed on the [“Globals” page](https://nodejs.org/dist/latest-v17.x/docs/api/globals.html).\r\n\r\nBy referencing the original (“Globals”) location from a brand new section dedicated to `DOMException` on our “Errors” page, I am thinking that we may be able to have it listed on both pages similar to how we list `AssertionError` on both [`/api/errors.html`](https://nodejs.org/api/errors.html#class-assertionerror) and [`/api/assert.html`](https://nodejs.org/api/assert.html#class-assertassertionerror). Thoughts?\r\n\r\nP.S. Unsure of how relevant this may be (perhaps wrt the potential misclassification of `AbortError` raised in #40692), but this seems worth mentioning in this issue…\r\n\r\nAlong w/ [`structuredClone`](https://nodejs.org/api/globals.html#structuredclonevalue-options) ([spec link](https://html.spec.whatwg.org/multipage/structured-data.html#structured-cloning)) — which was also made globally available in v17.0.0 — we appear to have added our first (?) couple of objects to be classified as [“platform objects”](https://webidl.spec.whatwg.org/#es-platform-objects) according to [Web IDL](https://webidl.spec.whatwg.org/) (at least that’s mine and @domenic’s current interpret of the spec, anyway). Perhaps it may be worth explicitly identifying them as such in our documentation?\r\n\r\nAny additional information/suggestions would be appreciated. It seems like it could simply be a minor oversight unless I am mistaken.\r\n\r\n/cc @aduh95 @targos @Trott @BridgeAR @addaleax @mcollina @benjamingr @jasnell (et al. who may have more context)\r\n\r\n---\r\n\r\n\u003c!-- Use “[x]” to check the box below if you are\r\ninterested in contributing. -->\r\n\r\n- [x] I would like to work on this issue and\r\n submit a pull request.\r\n","author":{"url":"https://github.com/DerekNonGeneric","@type":"Person","name":"DerekNonGeneric"},"datePublished":"2021-11-11T19:40:48Z","url":"https://github.com/nodejs/node/issues/40789"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:1ba6415b-be10-b757-871c-a9ac14cc40ee |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | B314:3A3994:8106C5:A8456B:6AED35E1 |
| html-safe-nonce | 54ee2bc76c1b92c5ab90c9a305b5a01e689d54feafdc76135ede55e831c37a6a |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCMzE0OjNBMzk5NDo4MTA2QzU6QTg0NTZCOjZBRUQzNUUxIiwidmlzaXRvcl9pZCI6IjY1MzA0Njc2NDE4NzEzODE5ODUiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | e93590f1071a9b5fe7a34b3ebe913c40965fd5626ed7b8f1fa6600c69d22249c |
| hovercard-subject-tag | issue:1051301651 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/nodejs/node/40789/issue_layout |
| twitter:image | https://opengraph.githubassets.com/6701d8df1aa5120465002847f52c7dc149eb2213737522a7e4949daf169baf74/nodejs/node/issues/40789 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/6701d8df1aa5120465002847f52c7dc149eb2213737522a7e4949daf169baf74/nodejs/node/issues/40789 |
| og:image:alt | 📗 API Reference Docs Problem Version: v17.0.0 Platform: Linux 5.10.47-linuxkit x86_64 GNU/Linux Subsystem: errors Location Section of the site where the content exists Affected URL(s): https://node... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | DerekNonGeneric |
| hostname | github.com |
| expected-hostname | github.com |
| None | 26c92a9388ddfad3fa88d132b5d5f0b4747030233dcc4e5efb05f1cbae152184 |
| turbo-cache-control | no-preview |
| go-import | github.com/nodejs/node git https://github.com/nodejs/node.git |
| octolytics-dimension-user_id | 9950313 |
| octolytics-dimension-user_login | nodejs |
| octolytics-dimension-repository_id | 27193779 |
| octolytics-dimension-repository_nwo | nodejs/node |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 27193779 |
| octolytics-dimension-repository_network_root_nwo | nodejs/node |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | c629ad99c254d306375fc8354d04321c2c362236 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width