Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
typedoc-plugin-missing-exports
Advanced tools
Automatically document symbols which aren't exported but are referenced.
Supports TypeDoc 0.24.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.2.0.1 (2023-07-29)
FAQs
Include non-exported types in TypeDoc documentation
The npm package typedoc-plugin-missing-exports receives a total of 74,447 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.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.