Provides comprehensive API docs for the Typescript built-in libs covering the DOM, ES2023, and Web Worker APIs. The DOM API docs also include the WebCodecs, WebGPU, and WebXR APIs.

The docs are generated from the following sources:

• Typescript built-in libs (5.6.2)
• @types/dom-webcodecs (0.1.11)
• @webgpu/types (0.1.45)
• @types/webxr (0.5.20)

The @mdn/browser-compat-data (5.6.1) package is cross-linked against all symbols and a web component provides links to MDN docs and relevant specifications embedded in the API docs provided.

---

If you are using TypeDoc to generate documentation there are several plugins available to link all TS built-in lib symbols to the hosted TS Lib docs. You can find the NPM package here: @typhonjs-typedoc/ts-lib-docs

Include the following in your devDependencies in package.json:

{
   "devDependencies": {
      "@typhonjs-typedoc/ts-lib-docs": "2024.9.18",
      "@typhonjs-typedoc/typedoc-theme-dmt": "^0.2.0",
      "typedoc": "^0.26.6"
   }
}
Copy

The date of generation <year>.<month>.<day> is used instead of normal SEMVER.

Then in your TypeDoc configuration / JSON include:

{
   "plugin": [         
      "@typhonjs-typedoc/typedoc-theme-dmt",
      "@typhonjs-typedoc/ts-lib-docs/typedoc/ts-links/dom/2024",
      "@typhonjs-typedoc/ts-lib-docs/typedoc/ts-links/es/2024"
   ]
}
Copy

You should choose either the "dom" or "worker" ts-lib-docs plugin and not both. The "worker" plugin is omitted from the above example. The es plugin includes the Typescript built-in library Javascript API.

Synergy

• The TS Lib docs are generated with the Default Modern Theme / @typhonjs-typedoc/typedoc-theme-dmt. This is a theme augmentation that adds features and fixes rough edges of the default TypeDoc theme.

• A zero / low configuration CLI frontend @typhonjs-typedoc/typedoc-pkg is available for TypeDoc that supports generating documentation from repositories utilizing package.json configured with export condition types.

---

Please note that the TS Lib API docs are presently hosted through Github pages while a permanent hosting location is found. IE if this gets popular GH bandwidth concerns may come into play.

You may open an issue at ts-lib-docs repository for discussion / feedback.