Interface TypeDocOptionMap

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.

declare module "typedoc" {
  export interface TypeDocOptionMap {
    pluginOption: string[];
  }
}
interface TypeDocOptionMap {
    alwaysCreateEntryPointModule: boolean;
    basePath: string;
    blockTags: `@${string}`[];
    cacheBust: boolean;
    cascadedModifierTags: `@${string}`[];
    categorizeByGroup: boolean;
    categoryOrder: string[];
    cleanOutputDir: boolean;
    cname: string;
    commentStyle: {
        All: "all";
        Block: "block";
        JSDoc: "jsdoc";
        Line: "line";
    };
    compilerOptions: unknown;
    customCss: string;
    customFooterHtml: string;
    customFooterHtmlDisableWrapper: boolean;
    customJs: string;
    darkHighlightTheme: BundledTheme;
    defaultCategory: string;
    disableGit: boolean;
    disableSources: boolean;
    emit: {
        both: "both";
        docs: "docs";
        none: "none";
    };
    entryPoints: string[];
    entryPointStrategy: {
        Expand: "expand";
        Merge: "merge";
        Packages: "packages";
        Resolve: "resolve";
    };
    exclude: string[];
    excludeCategories: string[];
    excludeExternals: boolean;
    excludeInternal: boolean;
    excludeNotDocumented: boolean;
    excludeNotDocumentedKinds: KindString[];
    excludePrivate: boolean;
    excludeProtected: boolean;
    excludeReferences: boolean;
    excludeTags: `@${string}`[];
    externalPattern: string[];
    externalSymbolLinkMappings: ManuallyValidatedOption<Record<string, Record<string, string>>>;
    githubPages: boolean;
    gitRemote: string;
    gitRevision: string;
    groupOrder: string[];
    headings: {
        document: boolean;
        readme: boolean;
    };
    help: boolean;
    hideGenerator: boolean;
    hideParameterTypesInTitle: boolean;
    highlightLanguages: string[];
    hostedBaseUrl: string;
    includeVersion: boolean;
    inlineTags: `@${string}`[];
    intentionallyNotExported: string[];
    jsDocCompatibility: JsDocCompatibility;
    json: string;
    kindSortOrder: KindString[];
    lang: string;
    lightHighlightTheme: BundledTheme;
    locales: ManuallyValidatedOption<Record<string, Record<string, string>>>;
    logLevel: typeof LogLevel;
    markdownItLoader: ManuallyValidatedOption<((parser: any) => void)>;
    markdownItOptions: ManuallyValidatedOption<Record<string, unknown>>;
    markdownLinkExternal: boolean;
    maxTypeConversionDepth: number;
    modifierTags: `@${string}`[];
    name: string;
    navigation: {
        compactFolders: boolean;
        excludeReferences: boolean;
        includeCategories: boolean;
        includeFolders: boolean;
        includeGroups: boolean;
    };
    navigationLeaves: string[];
    navigationLinks: ManuallyValidatedOption<Record<string, string>>;
    options: string;
    out: string;
    packageOptions: ManuallyValidatedOption<TypeDocOptions>;
    plugin: string[];
    preserveLinkText: boolean;
    preserveWatchOutput: boolean;
    pretty: boolean;
    projectDocuments: string[];
    readme: string;
    requiredToBeDocumented: KindString[];
    searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>;
    searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>;
    searchInComments: boolean;
    searchInDocuments: boolean;
    showConfig: boolean;
    sidebarLinks: ManuallyValidatedOption<Record<string, string>>;
    skipErrorChecking: boolean;
    sort: (
        | "kind"
        | "instance-first"
        | "alphabetical"
        | "source-order"
        | "alphabetical-ignoring-documents"
        | "enum-value-ascending"
        | "enum-value-descending"
        | "enum-member-source-order"
        | "static-first"
        | "visibility"
        | "required-first"
        | "external-last"
        | "documents-first"
        | "documents-last")[];
    sortEntryPoints: boolean;
    sourceLinkExternal: boolean;
    sourceLinkTemplate: string;
    suppressCommentWarningsInDeclarationFiles: boolean;
    theme: string;
    titleLink: string;
    treatValidationWarningsAsErrors: boolean;
    treatWarningsAsErrors: boolean;
    tsconfig: string;
    useHostedBaseUrlForAbsoluteLinks: boolean;
    useTsLinkResolution: boolean;
    validation: ValidationOptions;
    version: boolean;
    visibilityFilters: ManuallyValidatedOption<{
        external?: boolean;
        inherited?: boolean;
        private?: boolean;
        protected?: boolean;
        [tag: `@${string}`]: boolean;
    }>;
    watch: boolean;
}

Properties

alwaysCreateEntryPointModule basePath blockTags cacheBust cascadedModifierTags categorizeByGroup categoryOrder cleanOutputDir cname commentStyle compilerOptions customCss customFooterHtml customFooterHtmlDisableWrapper customJs darkHighlightTheme defaultCategory disableGit disableSources emit entryPoints entryPointStrategy exclude excludeCategories excludeExternals excludeInternal excludeNotDocumented excludeNotDocumentedKinds excludePrivate excludeProtected excludeReferences excludeTags externalPattern externalSymbolLinkMappings githubPages gitRemote gitRevision groupOrder headings help hideGenerator hideParameterTypesInTitle highlightLanguages hostedBaseUrl includeVersion inlineTags intentionallyNotExported jsDocCompatibility json kindSortOrder lang lightHighlightTheme locales logLevel markdownItLoader markdownItOptions markdownLinkExternal maxTypeConversionDepth modifierTags name navigation navigationLeaves navigationLinks options out packageOptions plugin preserveLinkText preserveWatchOutput pretty projectDocuments readme requiredToBeDocumented searchCategoryBoosts searchGroupBoosts searchInComments searchInDocuments showConfig sidebarLinks skipErrorChecking sort sortEntryPoints sourceLinkExternal sourceLinkTemplate suppressCommentWarningsInDeclarationFiles theme titleLink treatValidationWarningsAsErrors treatWarningsAsErrors tsconfig useHostedBaseUrlForAbsoluteLinks useTsLinkResolution validation version visibilityFilters watch

Properties

alwaysCreateEntryPointModule

alwaysCreateEntryPointModule: boolean

basePath

basePath: string

blockTags

blockTags: `@${string}`[]

cacheBust

cacheBust: boolean

cascadedModifierTags

cascadedModifierTags: `@${string}`[]

categorizeByGroup

categorizeByGroup: boolean

categoryOrder

categoryOrder: string[]

cleanOutputDir

cleanOutputDir: boolean

cname

cname: string

commentStyle

commentStyle: {
    All: "all";
    Block: "block";
    JSDoc: "jsdoc";
    Line: "line";
}

compilerOptions

compilerOptions: unknown

customCss

customCss: string

customFooterHtml

customFooterHtml: string

customFooterHtmlDisableWrapper

customFooterHtmlDisableWrapper: boolean

customJs

customJs: string

darkHighlightTheme

darkHighlightTheme: BundledTheme

defaultCategory

defaultCategory: string

disableGit

disableGit: boolean

disableSources

disableSources: boolean

emit

emit: {
    both: "both";
    docs: "docs";
    none: "none";
}

entryPoints

entryPoints: string[]

entryPointStrategy

entryPointStrategy: {
    Expand: "expand";
    Merge: "merge";
    Packages: "packages";
    Resolve: "resolve";
}

Type declaration

  • ReadonlyExpand: "expand"

    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.

  • 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.

exclude

exclude: string[]

excludeCategories

excludeCategories: string[]

excludeExternals

excludeExternals: boolean

excludeInternal

excludeInternal: boolean

excludeNotDocumented

excludeNotDocumented: boolean

excludeNotDocumentedKinds

excludeNotDocumentedKinds: KindString[]

excludePrivate

excludePrivate: boolean

excludeProtected

excludeProtected: boolean

excludeReferences

excludeReferences: boolean

excludeTags

excludeTags: `@${string}`[]

externalPattern

externalPattern: string[]

externalSymbolLinkMappings

externalSymbolLinkMappings: ManuallyValidatedOption<Record<string, Record<string, string>>>

githubPages

githubPages: boolean

gitRemote

gitRemote: string

gitRevision

gitRevision: string

groupOrder

groupOrder: string[]

headings

headings: {
    document: boolean;
    readme: boolean;
}

help

help: boolean

hideGenerator

hideGenerator: boolean

hideParameterTypesInTitle

hideParameterTypesInTitle: boolean

highlightLanguages

highlightLanguages: string[]

hostedBaseUrl

hostedBaseUrl: string

includeVersion

includeVersion: boolean

inlineTags

inlineTags: `@${string}`[]

intentionallyNotExported

intentionallyNotExported: string[]

jsDocCompatibility

jsDocCompatibility: JsDocCompatibility

json

json: string

kindSortOrder

kindSortOrder: KindString[]

lang

lang: string

lightHighlightTheme

lightHighlightTheme: BundledTheme

locales

locales: ManuallyValidatedOption<Record<string, Record<string, string>>>

logLevel

logLevel: typeof LogLevel

markdownItLoader

markdownItLoader: ManuallyValidatedOption<((parser: any) => void)>

Will be called when TypeDoc is setting up the markdown parser to use to render markdown. Can be used to add markdown-it plugins to the parser with code like this:

// typedoc.config.mjs
import iterator from "markdown-it-for-inline";
export default {
    /** @param {MarkdownIt} parser */
    markdownItLoader(parser) {
        parser.use(iterator, "foo_replace", "text", function(tokens, idx) {
            tokens[idx].content = tokens[idx].content.replace(/foo/g, 'bar');
        });
    }
}

Note: Unfortunately, markdown-it doesn't ship its own types, so parser isn't strictly typed here.

markdownItOptions

markdownItOptions: ManuallyValidatedOption<Record<string, unknown>>

markdownLinkExternal

markdownLinkExternal: boolean

maxTypeConversionDepth

maxTypeConversionDepth: number

modifierTags

modifierTags: `@${string}`[]

name

name: string

navigation

navigation: {
    compactFolders: boolean;
    excludeReferences: boolean;
    includeCategories: boolean;
    includeFolders: boolean;
    includeGroups: boolean;
}

navigationLeaves

navigationLeaves: string[]

navigationLinks

navigationLinks: ManuallyValidatedOption<Record<string, string>>

options

options: string

out

out: string

packageOptions

packageOptions: ManuallyValidatedOption<TypeDocOptions>

plugin

plugin: string[]

preserveLinkText

preserveLinkText: boolean

preserveWatchOutput

preserveWatchOutput: boolean

pretty

pretty: boolean

projectDocuments

projectDocuments: string[]

readme

readme: string

requiredToBeDocumented

requiredToBeDocumented: KindString[]

searchCategoryBoosts

searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>

searchGroupBoosts

searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>

searchInComments

searchInComments: boolean

searchInDocuments

searchInDocuments: boolean

showConfig

showConfig: boolean

sidebarLinks

sidebarLinks: ManuallyValidatedOption<Record<string, string>>

skipErrorChecking

skipErrorChecking: boolean

sort

sort: (
    | "kind"
    | "instance-first"
    | "alphabetical"
    | "source-order"
    | "alphabetical-ignoring-documents"
    | "enum-value-ascending"
    | "enum-value-descending"
    | "enum-member-source-order"
    | "static-first"
    | "visibility"
    | "required-first"
    | "external-last"
    | "documents-first"
    | "documents-last")[]

sortEntryPoints

sortEntryPoints: boolean

sourceLinkExternal

sourceLinkExternal: boolean

sourceLinkTemplate

sourceLinkTemplate: string

suppressCommentWarningsInDeclarationFiles

suppressCommentWarningsInDeclarationFiles: boolean

theme

theme: string

titleLink

titleLink: string

treatValidationWarningsAsErrors

treatValidationWarningsAsErrors: boolean

treatWarningsAsErrors

treatWarningsAsErrors: boolean

tsconfig

tsconfig: string

useHostedBaseUrlForAbsoluteLinks

useHostedBaseUrlForAbsoluteLinks: boolean

useTsLinkResolution

useTsLinkResolution: boolean

validation

validation: ValidationOptions

version

version: boolean

visibilityFilters

visibilityFilters: ManuallyValidatedOption<{
    external?: boolean;
    inherited?: boolean;
    private?: boolean;
    protected?: boolean;
    [tag: `@${string}`]: boolean;
}>

watch

watch: boolean

Settings

Member Visibility

On This Page

Properties
alwaysCreateEntryPointModulebasePathblockTagscacheBustcascadedModifierTagscategorizeByGroupcategoryOrdercleanOutputDircnamecommentStylecompilerOptionscustomCsscustomFooterHtmlcustomFooterHtmlDisableWrappercustomJsdarkHighlightThemedefaultCategorydisableGitdisableSourcesemitentryPointsentryPointStrategyexcludeexcludeCategoriesexcludeExternalsexcludeInternalexcludeNotDocumentedexcludeNotDocumentedKindsexcludePrivateexcludeProtectedexcludeReferencesexcludeTagsexternalPatternexternalSymbolLinkMappingsgithubPagesgitRemotegitRevisiongroupOrderheadingshelphideGeneratorhideParameterTypesInTitlehighlightLanguageshostedBaseUrlincludeVersioninlineTagsintentionallyNotExportedjsDocCompatibilityjsonkindSortOrderlanglightHighlightThemelocaleslogLevelmarkdownItLoadermarkdownItOptionsmarkdownLinkExternalmaxTypeConversionDepthmodifierTagsnamenavigationnavigationLeavesnavigationLinksoptionsoutpackageOptionspluginpreserveLinkTextpreserveWatchOutputprettyprojectDocumentsreadmerequiredToBeDocumentedsearchCategoryBoostssearchGroupBoostssearchInCommentssearchInDocumentsshowConfigsidebarLinksskipErrorCheckingsortsortEntryPointssourceLinkExternalsourceLinkTemplatesuppressCommentWarningsInDeclarationFilesthemetitleLinktreatValidationWarningsAsErrorstreatWarningsAsErrorstsconfiguseHostedBaseUrlForAbsoluteLinksuseTsLinkResolutionvalidationversionvisibilityFilterswatch