typedoc-plugin-missing-exports
Advanced tools
Changelog
2.1.0 (2023-08-25)
Readme
Automatically document symbols which aren't exported but are referenced.
Supports TypeDoc 0.24.x and 0.25.x
TypeDoc 0.20 switched from documenting each file individually to documenting based on entry points. TypeDoc looks at each provided entry point 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 to. 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.
npm install typedoc-plugin-missing-exports
npx typedoc --plugin typedoc-plugin-missing-exports
internalModule - Define the name of the module that internal symbols which are not exported should be placed into.FAQs
Unknown package
We found that typedoc-plugin-missing-exports demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.