Render custom output name instead of "__namedParameters" for destructuring params

[pushkov-fedor]

Hi everyone! I work on project that contains both TypeScript and JavaScript files. I use TypeDoc for generating documentation. It works awesome, but i would like to know: is there a way to replace default "__namedParameters" output for something else (e.g. "options")?

Thank you!

[raineorshine]

Is looks like __namedParameters is hardcoded in one place:

typedoc/src/lib/converter/factories/parameter.ts

Line 31 in d18664d

parameter.name = '__namedParameters';

Perhaps an option like --namedParametersName could be added to set the display name? Then, correct me if I'm wrong, this would be accessible as converter.namedParametersName within createParameter? Happy to submit a PR with some help if desired.

[Gerrit0]

--namedParametersName

I don't particularly care for this, or the existing implementation... Right now TypeDoc does bad things if you destructure more than one argument. I'd rather switch to generating arg_# like the language service does

type Foo = [1, 2, 3]
declare const x: (...arg: Foo) => string
// hover      ^

That said, a plugin which makes this change is pretty easy to write (untested)

const { Converter } = require('typedoc')
export function load({ application }) {
  application.converter.on(Converter.EVENT_CREATE_PARAMETER, param => {
    if (param.name === '__namedParameters') param.name = 'options'
  })
}

[cherryblossom000]

A plugin that works:

import {Converter} from 'typedoc/dist/lib/converter'
import type {ParameterReflection} from 'typedoc'
import type {Context} from 'typedoc/dist/lib/converter'
import type {PluginHost} from 'typedoc/dist/lib/utils'

export function load({application}: PluginHost) {
  application.converter.on(Converter.EVENT_CREATE_PARAMETER, (_: Context, param: ParameterReflection) => {
    if (param.name === '__namedParameters') param.name = 'options'
  })
}

Edit: I created a plugin that does exactly this.

[cherryblossom000]

Thanks to #1704, the name of a destructured parameter is inferred by the @param tag and my plugin is no longer necessary!