Typedoc

BuildOptions

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

Name & Description	Option(s)	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'
logMode The log level for runtime logs.	\| 'info' \| 'quiet'	'info'
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
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'

Default

'only-public'

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.

logMode

Type

| 'info'
| 'quiet'

Default

'info'

Description

The log level for runtime logs.

outputFile

Type

string

Default

".typedoc/doc-props.json"

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.

typedocOptions

Type

Partial<TypeDocOptions>

Description

Optional overrides for typedoc Application options.

Refer to defaultOptions for details about the default configuration.

QuiDocsPluginOptions

MDX Docs