cybersemics / typedoc-plugin-rename-named-parameters

Typedoc plugin which renames default __namedParameters

typedoc-plugin-rename-named-parameters

Plugin

A plugin for Typedoc

When using Typedoc for API docs generation you may want to render custom output name instead of "__namedParameters" for destructuring params.

Installing

npm install typedoc-plugin-rename-named-parameters --save-dev

Usage

Arguments

--namedParameters <yourCustomName>

Specifies the name which will be rendered instead of __namedParameters.

You can specify namedParameters inside TypeDoc's configuration file by "namedParameters": "yourCustomName",