Describes all TypeDoc options. Used internally to provide better types when fetching options.
External consumers should likely use TypeDocOptions instead.
If writing a plugin, you may find it useful to use declaration merging to add your options to this interface
so that you have autocomplete when using app.options.getValue.
The default behavior in v0.21 and earlier. Behaves like the resolve behavior, but will recursively
expand directories into an entry point for each file within the directory.
ReadonlyLegacyPackages: "legacy-packages"
Will be removed in 0.25, this was called packages mode in 0.24.
Alternative resolution mode useful for monorepos. With this mode, TypeDoc will look for a package.json
and tsconfig.json under each provided entry point. The main field of each package will be documented.
ReadonlyMerge: "merge"
Merges multiple previously generated output from TypeDoc's --json output together into a single project.
ReadonlyPackages: "packages"
Run TypeDoc in each directory passed as an entry point. Once all directories have been converted,
use the merge option to produce final output.
ReadonlyResolve: "resolve"
The default behavior in v0.22+, expects all provided entry points as being part of a single program.
Any directories included in the entry point list will result in dir/index.([cm][tj]s|[tj]sx?) being used.
Describes all TypeDoc options. Used internally to provide better types when fetching options. External consumers should likely use TypeDocOptions instead.
If writing a plugin, you may find it useful to use declaration merging to add your options to this interface so that you have autocomplete when using
app.options.getValue
.