Interface TypeDocOptions

interface TypeDocOptions {
    entryPoints: string[];
    entryPointStrategy?: "resolve" | "expand" | "merge" | "packages";
    name?: string;
    plugin?: string[];
    skipErrorChecking?: boolean;
    tsconfig?: string;
}

Properties

entryPoints entryPointStrategy? name? plugin? skipErrorChecking? tsconfig?

Properties

entryPoints

entryPoints: string[]

OptionalentryPointStrategy

entryPointStrategy?: "resolve" | "expand" | "merge" | "packages"

TypeDoc entry-point strategy. Defaults to 'resolve'.

Optionalname

name?: string

Optionalplugin

plugin?: string[]

Optional TypeDoc theme/plugin passthroughs

OptionalskipErrorChecking

skipErrorChecking?: boolean

Skip TypeScript error checking before conversion. Defaults to true so documentation still generates when a project has unrelated type errors.

Optionaltsconfig

tsconfig?: string

Settings

Member Visibility

On This Page

Properties