Update typedoc and export doc for quickjs modules

Author: Sytten

package.json

@@ -3,8 +3,8 @@
   "private": true,
   "devDependencies": {
     "typescript": "5.6.2",
-    "typedoc": "0.26.7",
-    "typedoc-plugin-markdown": "4.2.9",
-    "typedoc-plugin-missing-exports": "3.0.0"
+    "typedoc": "0.27.6",
+    "typedoc-plugin-markdown": "4.4.1",
+    "typedoc-plugin-missing-exports": "3.1.0"
   }
 }

packages/quickjs-types/documentation.md

@@ -0,0 +1,29 @@
+# QuickJS Modules
+
+Here is the reference of the modules available in our engine.
+
+This documentation is auto-generated from the Typescript typing ([`@caido/quickjs-types`](https://www.npmjs.com/package/@caido/quickjs-types)) which is the source of truth.
+
+Some elements are similar to `Node.JS`, but some imports will be different and start with `caido:`.
+
+## Modules
+
+| Module                                 | Description              | Import             | Global |
+| -------------------------------------- | ------------------------ | ------------------ | ------ |
+| [url](extra/url.md)                    | URL utilities            | N/A                | ✔︎     |
+| [abort](llrt/abort.md)                 | Abort signaling          | N/A                | ✔︎     |
+| [buffer](llrt/buffer.md)               | Buffers                  | `buffer`           | ✔︎     |
+| [child_process](llrt/child_process.md) | Process spawning         | `child_process`    | ✘      |
+| [console](extra/console.md)            | Console logging          | N/A                | ✔︎     |
+| [crypto](llrt/crypto.md)               | Cryptographic primitives | `crypto`           | ✘      |
+| [dom-events](llrt/dom-events.md)       | Events                   | N/A                | ✔︎     |
+| [fs](llrt/fs/index.md)                 | File system              | `fs`, `fs/promise` | ✘      |
+| [http](caido/http.md)                  | Fetch implementation     | `caido:http`       | ✘      |
+| [globals](llrt/globals/index.md)       | Global classes           | N/A                | ✔︎     |
+| [net](llrt/net.md)                     | Sockets                  | `net`              | ✘      |
+| [os](extra/os.md)                      | OS information           | `os`               | ✘      |
+| [path](llrt/path/index.md)             | Path transformation      | `path`             | ✘      |
+| [process](llrt/process.md)             | Process information      | `process`          | ✔︎     |
+| [sqlite](extra/sqlite.md)              | SQlite access            | `sqlite`           | ✘      |
+| [stream](llrt/stream.md)               | Streams (basic)          | `stream`           | ✔︎     |
+| [timers](extra/timers.md)              | Timers                   | N/A                | ✔︎     |

packages/quickjs-types/package.json

@@ -9,6 +9,7 @@
     "src/*"
   ],
   "scripts": {
+    "documentation": "typedoc",
     "typing": "./scripts/typing.sh"
   }
 }

packages/quickjs-types/typedoc.json

@@ -0,0 +1,24 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": [
+    "src/caido/http.d.ts",
+    "src/extra/console.d.ts",
+    "src/extra/os.d.ts",
+    "src/extra/sqlite.d.ts",
+    "src/extra/timers.d.ts",
+    "src/extra/url.d.ts",
+    "src/llrt/abort.d.ts",
+    "src/llrt/buffer.d.ts",
+    "src/llrt/child_process.d.ts",
+    "src/llrt/crypto.d.ts",
+    "src/llrt/dom-events.d.ts",
+    "src/llrt/fs.d.ts",
+    "src/llrt/globals.d.ts",
+    "src/llrt/net.d.ts",
+    "src/llrt/path.d.ts",
+    "src/llrt/process.d.ts",
+    "src/llrt/stream.d.ts"
+  ],
+  "externalPattern": ["**/node_modules/typescript/**"],
+  "theme": "override"
+}