TypeDocOptions type definition bug

[pizzafroide]

Search terms

TypeDocOptions

Expected Behavior

TypeDocOptions type should match typedoc's official documentation.

Actual Behavior

TypeDocOptions type resolves to:

type TypeDocOptions = {
    options?: unknown;
    tsconfig?: unknown;
    compilerOptions?: unknown;
    plugin?: string[] | undefined;
    lang?: string | undefined;
    locales?: Record<string, Record<string, string>> | undefined;
    packageOptions?: typedoc.Configuration.TypeDocPackageOptions | undefined;
    entryPoints?: string[] | undefined;
    entryPointStrategy?: string | undefined;
    alwaysCreateEntryPointModule?: string | undefined;
    projectDocuments?: string[] | undefined;
    exclude?: string[] | undefined;
    externalPattern?: string[] | undefined;
    excludeExternals?: string | undefined;
    excludeNotDocumented?: string | undefined;
    ... 95 more ...;
    skipErrorChecking?: string | undefined;
}

Steps to reproduce the bug

import * as typedoc from 'typedoc'

await typedoc.Application.bootstrapWithPlugins({
  excludeNotDocumented: true,
//~~~~~~~~~~~~~~~~~~~~ Type 'boolean' is not assignable to type 'string'. ts(2322)
})

Environment

• TypeDoc version: 0.28.16
• TypeScript version: 5.9.3
• Node.js version: 25.0.0
• OS: Windows 11

[Gerrit0]

I cannot reproduce this. Hovering over Test in below shows boolean | undefined as expected. I suspect your language server may have gotten confused and a restart will take care of it.

type Test = typedoc.TypeDocOptions["excludeNotDocumented"]

[pizzafroide]

I've created a minimal example module from scratch and, in fact, with just typedoc, typescript and @types/node installed, I also get boolean | undefined when hovering Type in vscode. Although, the type changes to string | undefined when adding a tsconfig.json file.

package.json

{
  "name": "test-typedoc",
  "version": "0.0.1",
  "description": "Test for typedoc",
  "type": "module",
  "scripts": {
    "build": "tsc"
  },
  "dependencies": {
    "typedoc": "^0.28.17"
  },
  "devDependencies": {
    "@types/node": "^25.2.3",
    "typescript": "^5.9.3"
  }
}

src/index.ts

import * as typedoc from 'typedoc'

await typedoc.Application.bootstrapWithPlugins({
  excludeNotDocumented: true,
})

tsconfig.json

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "esnext",
    "lib": ["ES2020"],
    "declaration": true,
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "moduleResolution": "node",
    "resolveJsonModule": true
  },
  "include": ["src/**/*"]
}

Which results in:

$ npm run build

> test-typedoc@0.0.1 build
> tsc

src/index.ts:4:3 - error TS2322: Type 'boolean' is not assignable to type 'string'.

4   excludeNotDocumented: true,
    ~~~~~~~~~~~~~~~~~~~~


Found 1 error in src/index.ts:4

[Gerrit0]

skipLibCheck is an absolutely awful compiler option. If you turn that off, you'll notice that "moduleResolution": "node" does not support Node's subpath imports feature, which TypeDoc relies on.

This is working as intended, the node module resolution is not recommended for Node version 16 and later, having been replaced with "moduleResolution": "node16". Furthermore, the node` option will be deprecated in TypeScript 6.0.

[pizzafroide]

Fair enough! Although, if TypeDoc relies on subpaths imports, I suggest emitting a warning when nodeResolution is detected to be "node" instead of "node16" or "nodenext".