typedoc-plugin-markdown: beautify parameter table and signature title output of destructured params

[Xunnamius]

First off, thank you for typedoc and typedoc-plugin-markdown, they've done wonders for my documentation game :)

So I've been using a forked version of the typedoc-plugin-markdown package that updates how destructured parameters are represented in Markdown.

For example:

export function deleteme(...[x, y]: [number, string]) {
  console.log(x, y);
}

export function deleteme2(
  { a = true, b = true }: { a?: boolean; b?: boolean } = {},
  state: boolean,
  fate: number
) {
  console.log(a, b, state, fate);
}

export function deleteme3(
  { a = true, b = true }: { a?: boolean; b?: boolean } = {},
  { c = true, d = true }: { c?: boolean; d?: boolean } = {},
  state: boolean,
  fate: number,
  { e = true, f = true }: { e?: boolean; f?: boolean } = {}
) {
  console.log(a, b, c, d, e, f, state, fate);
}

Yields (using my fork):

deleteme

▸ deleteme(...«destructured»): void

Parameters

Name	Type
...«destructured»	[number, string]

Returns

void

Defined in

index.ts:8

---

deleteme2

▸ deleteme2(«destructured»?, state, fate): void

Parameters

Name	Type
«destructured»	Object
› a?	boolean
› b?	boolean
state	boolean
fate	number

Returns

void

Defined in

index.ts:12

---

deleteme3

▸ deleteme3(«destructured»?, «destructured»?, state, fate, «destructured»?): void

Parameters

Name	Type
«destructured»	Object
› a?	boolean
› b?	boolean
«destructured»	Object
› c?	boolean
› d?	boolean
state	boolean
fate	number
«destructured»	Object
› e?	boolean
› f?	boolean

Returns

void

Defined in

index.ts:20

Yields (not using my fork):

deleteme

▸ deleteme(...__namedParameters): void

Parameters

Name	Type
...__namedParameters	[number, string]

Returns

void

Defined in

index.ts:8

---

deleteme2

▸ deleteme2(__namedParameters?, state, fate): void

Parameters

Name	Type
__namedParameters	Object
__namedParameters.a?	boolean
__namedParameters.b?	boolean
state	boolean
fate	number

Returns

void

Defined in

index.ts:12

---

deleteme3

▸ deleteme3(__namedParameters?, __namedParameters?, state, fate, __namedParameters?): void

Parameters

Name	Type
__namedParameters	Object
__namedParameters.a?	boolean
__namedParameters.b?	boolean
__namedParameters	Object
__namedParameters.c?	boolean
__namedParameters.d?	boolean
state	boolean
fate	number
__namedParameters	Object
__namedParameters.e?	boolean
__namedParameters.f?	boolean

Returns

void

Defined in

index.ts:20

Along with updated tests, I'm currently using my forked version across several projects if you want to test it out real quick:

npm install --save-dev https://xunn.at/typedoc-plugin-markdown
npx typedoc --plugin typedoc-plugin-markdown --out demo --readme none './src/*'

[tgreyuk]

Thank you - this works better (apologies for delay in response).