typedoc-plugin-missing-exports

typedoc-plugin-missing-exports

Automatically document symbols which aren't exported but are referenced.

Supports TypeDoc 0.24.x and 0.25.x

TypeDoc looks at each entry point provided and documents all exports from that entry point.

For libraries which export their full exposed API, this works well, but some packages are extremely resistant to exporting everything. This plugin is for them. After TypeDoc has finished converting packages, it will look for types which are referenced, but not exported, and place them into an internal module for that entry point (called <internal> by default).

If your project references classes which are built into the language (e.g. HTMLElement), this package will result in those types being documented too. If you want to prevent this, set TypeDoc's excludeExternals option to true. The default pattern for determining if a symbol is external will exclude everything within node_modules.

Usage

npm install typedoc-plugin-missing-exports
npx typedoc --plugin typedoc-plugin-missing-exports

Options

• internalModule - Define the name of the module that internal symbols which are not exported should be placed into.
• placeInternalsInOwningModule - Disable creating a module for internal symbols, and instead place them into the referencing module

Additional Reading

• https://github.com/TypeStrong/typedoc/issues/1657

Changelog

2.2.0 (2024-01-14)

• Fixed an issue where if a re-exported symbol referenced an internal symbol, and more than one entry point was provided to TypeDoc, this plugin would add the internal symbol to the last module, rather than the one it was associated with, #22.
• Added --placeInternalsInOwningModule option.