No Packages, Mate

    typedoc-plugin-missing-exports

    1.0.0 • Public • Published

    typedoc-plugin-missing-exports

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

    Supports TypeDoc 0.22.x and 0.23.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.

    Usage

    npm install typedoc-plugin-missing-exports

    TypeDoc will automatically use this plugin when present.

    Options

    • internalModule - Define the name of the module that internal symbols which are not exported should be placed into.

    Additional Reading

    Install

    npm i typedoc-plugin-missing-exports

    DownloadsWeekly Downloads

    34,496

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    10.9 kB

    Total Files

    8

    Last publish

    Collaborators

    • gerrit0