Product
Introducing Enhanced Alert Actions and Triage Functionality
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.
typedoc-plugin-missing-exports
Advanced tools
Changelog
3.0.0 (2024-06-22)
Readme
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
.
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, defaults to <internal>
.collapseInternalModule
- Include JS in the page to collapse all <internal>
entries in the navigation on page load.placeInternalsInOwningModule
- Disable creating a module for internal symbols, and instead place them into the referencing module.FAQs
Include non-exported types in TypeDoc documentation
The npm package typedoc-plugin-missing-exports receives a total of 65,101 weekly downloads. As such, typedoc-plugin-missing-exports popularity was classified as popular.
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.
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.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.