tpr

typedoc-plugin-rename-defaults

A TypeDoc plugin that renames the `default` exports to their original name

Showing:

Popularity

Downloads/wk

457

GitHub Stars

7

Maintenance

Last Commit

5d ago

Contributors

1

Package

Dependencies

0

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

typedoc-plugin-rename-defaults

A TypeDoc plugin that renames the default exports to their original name.

Why?

Since TypeDoc 0.20, the default exports fields do not get documented with their original names, but with the name "default". This plugin restores the behavior of TypeDoc 0.19 by keeping the original field name in the documentation. See typedoc#1521.

This is especially useful with the typedoc-plugin-merge-modules, as without it, multiple default exports would cause overlapping issues in the documentation generated. See typedoc-plugin-merge-modules#1.

Usage

Just install the plugin and TypeDoc will load it automatically.

npm install --save-dev typedoc-plugin-rename-defaults

For TypeDoc 0.22.x, you will need to add --entrypointStrategy expand to the typedoc command. Example:

// package.json

{
    "scripts": {
        "build-docs": "typedoc --entryPointStrategy expand src/"
    }
}

Credits

The implementation of this plugin was proposed by @Gerrit0 at #1521 (comment).

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100