typedoc-plugin-rename-defaults

0.1.0 • Public • Published

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

Credits

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

Package Sidebar

Install

npm i typedoc-plugin-rename-defaults@0.1.0

Version

0.1.0

License

MIT

Unpacked Size

3.62 kB

Total Files

4

Last publish

Collaborators

  • felipecrs