`PluginOptions` seems to be missing `Partial` for `tableColumnSettings`

[kaiyoma]

What package is the bug related to?

typedoc-plugin-markdown

Describe the issue

tableColumnSettings should be defined as Partial.

TypeDoc configuration

No response

Expected behavior

No response

[tgreyuk]

Hi @kaiyoma,

Sorry I don't understand what the request is here.

PluginOptions interface is publicly exported and includes all options including tableColumnSettings. Declaration merging also happens to the TypeDocOptionsMap as per https://typedoc.org/api/interfaces/Configuration.TypeDocOptionMap.html

Please can you confirm what the expected behaviour is?

Edit: This may also be of use - https://www.typedoc-plugin-markdown.org/docs/typedoc-usage#option-typings

Thanks.

[kaiyoma]

The issue is that I can't do this without a type error:

  tableColumnSettings: {
    hideSources: true,
  },

The type is missing Partial which forces the user to specify all properties, even though this is unnecessary. I filed a similar issue against typedoc (TypeStrong/typedoc#2878) which has already been fixed.

[kaiyoma]

Alternatively, since the interface seems to be defined inline, just make everything optional:

tableColumnSettings: {
    hideDefaults?: boolean;
    hideInherited?: boolean;
    hideModifiers?: boolean;
    hideOverrides?: boolean;
    hideSources?: boolean;
    hideValues?: boolean;
    leftAlignHeaders?: boolean;
}

Since each property defaults to false, the values shouldn't be required.

[tgreyuk]

Ok got it :) Thanks will take a look.

[tgreyuk]

available in typedoc-plugin-markdown@4.5.0