Typedoc

BuildOptions

The following data structure represents the configuration operations for the qui-typedoc config file.

Prop	Type	Default
apiFile The relative file path for the TypeDoc API JSON output. This file is generated by typedoc and contains the raw interfaces and types.	string
documentationScope It is recommended to leave this option alone unless you are debugging. The type information is a lot of data, so the detection strategy defaults to `only-public` to remove unused types. `only-public`: entities must be marked with an `@public` JSDoc tag to be processed into type documentation. `all`: every exported type will be processed. This will increase the size of the JSON model.	\| 'only-public' \| 'all'	'only-public'
importResolver Used to generate type info popups for resolved symbols.	(opts: { builder: ImportBuilder name: string namespace?: string type: ReferenceType }) => \| Promise< string \| undefined > \| string \| undefined
logMode The log level for runtime logs.	\| 'info' \| 'quiet'	'info'
moduleWhitelist Include all entities from these modules regardless of documentationScope. This field does nothing when documentationScope is set to `all`, as every module considered public in that case.	string[]

outputFile The relative file path for the resolved interfaces. Our parser strips the irrelevant information from the typedoc JSON and adds formatted API data featuring expanded pretty types, links to named types, and more.	string	".typedoc/doc-props.json"
prettyJson Whether to prettify the output JSON to make it human-readable.	boolean
referenceLinks Map of typedoc entity names to their corresponding page pathname on the docs site.	Record< string, string >
typedocOptions Optional overrides for typedoc Application options. Refer to defaultOptions for details about the default configuration.	Partial<TypeDocOptions>

apiFile

Type

string

Description

The relative file path for the TypeDoc API JSON output. This file is generated by typedoc and contains the raw interfaces and types.

documentationScope

Type

| 'only-public'
| 'all'

Description

It is recommended to leave this option alone unless you are debugging. The type information is a lot of data, so the detection strategy defaults to only-public to remove unused types.

only-public: entities must be marked with an @public JSDoc tag to be processed into type documentation.
all: every exported type will be processed. This will increase the size of the JSON model.

importResolver

Type

(opts: {
  builder: ImportBuilder
  name: string
  namespace?: string
  type: ReferenceType
}) =>
  | Promise<
      string | undefined
    >
  | string
  | undefined

Description

Used to generate type info popups for resolved symbols.

logMode

Type

| 'info'
| 'quiet'

Description

The log level for runtime logs.

moduleWhitelist

Type

string[]

Description

Include all entities from these modules regardless of documentationScope. This field does nothing when documentationScope is set to all, as every module considered public in that case.

outputFile

Type

string

Description

The relative file path for the resolved interfaces. Our parser strips the irrelevant information from the typedoc JSON and adds formatted API data featuring expanded pretty types, links to named types, and more.

prettyJson

Type

boolean

Description

Whether to prettify the output JSON to make it human-readable.

referenceLinks

Type

Record<
  string,
  string
>

Description

Map of typedoc entity names to their corresponding page pathname on the docs site.

typedocOptions

Type

Partial<TypeDocOptions>

Description

Optional overrides for typedoc Application options.

Refer to defaultOptions for details about the default configuration.

Last updated on Nov 11, 2025 by Ryan Bower

QuiDocsPluginOptions