TypeDocOptions seems to be missing Partial for packageOptions

[kaiyoma]

Search terms

TypeScript, TypeDocOptions, packageOptions

Expected Behavior

packageOptions should be defined as Partial.

Actual Behavior

error TS2740: Type '{ entryPoints: string[]; includeVersion: true; }' is missing the following properties from type 'TypeDocOptions': options, tsconfig, compilerOptions, plugin, and 100 more.

Steps to reproduce the bug

const config: TypeDocOptions = {
  entryPoints: [],
  entryPointStrategy: 'packages',
  packageOptions: {
    entryPoints: ['src/index.ts'],
    includeVersion: true,
  },
};

Environment

• Typedoc version: 0.27.9
• TypeScript version: 5.7.3
• Node.js version: 22.14.0

[kaiyoma]

Another issue with the types here (that should be addressed at the same time) is that not all options are applicable to packages, so those should be removed from the types. Currently, vscode is giving me autocomplete suggestions for options that only exist at the root.

[Gerrit0]

The options exist in both places, they simply don't have any effect when set there (unless some plugin forces rendering at each package level). I agree it makes sense to do this.

[kaiyoma]

@Gerrit0 Does your fix also address tableColumnSettings? I'm seeing the same problem there, where I can't specify only one property.

[Gerrit0]

That's not a typedoc option, so it's up to whatever plugin you're using to correctly specify it.

[kaiyoma]

Oh, I guess it's a question for @tgreyuk then (it's a Markdown option: https://typedoc-plugin-markdown.org/docs/options/display-options#tablecolumnsettings).