typedoc-plugin-reference-excluder

A plugin for TypeDoc that enables exclusion of references by RegEx and more.

What it does?

The plugin will remove references by RegEx.

Installation

npm install --save-dev typedoc typedoc-plugin-reference-excluder

Usage

npm script

"docs": "typedoc --plugin typedoc-plugin-reference-excluder ...options"

shell

$ npx typedoc --plugin typedoc-plugin-reference-excluder ...options

Note:

• The --plugin arg is optional - if omitted all installed plugins will run.
• The plugin needs to be executed from the same location as TypeDoc. Either use as an npm script or run npx typedoc.

Options

The following options can be used in addition to relevant TypeDoc options.

• --excludedFunctionOrMethod<string[]> A list of regular expressions (as strings) to match against methods/functions/accessors (e.g. to exclude all beginning with an underscore use ["^_"]).
• --excludedTags<string[]> A list of tags (with @ sign) to match against methods/functions/accessors (e.g. to exclude all deprecated methods use ["@deprecated"].
• --excludeConstructors<boolean> Remove constructors from the documentation. Defaults to false.
• --logExclusion<boolean> Log the excluded items. Defaults to false.

License

Copyright (c) 2021 - Daniel Arbel Kochavi & Wix.com under MIT license.