@nikovirtala/projen-constructs
    Preparing search index...

    Interface TypeDocConfiguration

    TypeDoc configuration

    https://typedoc.org/options/

    interface TypeDocConfiguration {
        basePath?: string;
        cacheBust?: boolean;
        categorizeByGroup?: boolean;
        cleanOutputDir?: boolean;
        commentStyle?: CommentStyle;
        defaultCategory?: string;
        defaultGroup?: string;
        defaultVisibility?: Visibility;
        disableGit?: boolean;
        disableSources?: boolean;
        entryPoints?: string[];
        entryPointStrategy?: EntryPointStrategy;
        exclude?: string[];
        excludeExternals?: boolean;
        excludeInternal?: boolean;
        excludePrivate?: boolean;
        excludeProtected?: boolean;
        externalPattern?: string[];
        externalSymbolLinkMappings?: Record<string, Record<string, string>>;
        gitRemote?: string;
        gitRevision?: string;
        hideGenerator?: boolean;
        hideParameterTypesInTitle?: boolean;
        includes?: string;
        intentionallyNotExported?: string[];
        json?: string;
        logLevel?: LogLevel;
        media?: string;
        name?: string;
        out?: string;
        packageJson?: string;
        readme?: string;
        requiredToBeDocumented?: string[];
        searchCategoryBoosts?: Record<string, number>;
        searchGroupBoosts?: Record<string, number>;
        searchInComments?: boolean;
        searchInDocuments?: boolean;
        sort?: string[];
        sortEntryPoints?: boolean;
        sourceLinkTemplate?: string;
        theme?: string;
        treatValidationWarningsAsErrors?: boolean;
        treatWarningsAsErrors?: boolean;
        tsBuildInfo?: string;
        tsconfig?: string;
        validation?: ValidationOptions;
    }
    Index

    Properties

    basePath? cacheBust? categorizeByGroup? cleanOutputDir? commentStyle? defaultCategory? defaultGroup? defaultVisibility? disableGit? disableSources? entryPoints? entryPointStrategy? exclude? excludeExternals? excludeInternal? excludePrivate? excludeProtected? externalPattern? externalSymbolLinkMappings? gitRemote? gitRevision? hideGenerator? hideParameterTypesInTitle? includes? intentionallyNotExported? json? logLevel? media? name? out? packageJson? readme? requiredToBeDocumented? searchCategoryBoosts? searchGroupBoosts? searchInComments? searchInDocuments? sort? sortEntryPoints? sourceLinkTemplate? theme? treatValidationWarningsAsErrors? treatWarningsAsErrors? tsBuildInfo? tsconfig? validation?

    Properties

    basePath?: string

    Specify the base path for all urls.

    https://typedoc.org/documents/Options.Output.html#basepath

    cacheBust?: boolean

    Include the generation time in links to prevent browsers from using a cached version.

    https://typedoc.org/documents/Options.Output.html#cachebust

    categorizeByGroup?: boolean

    Specify the categories that will be used to group reflections.

    https://typedoc.org/documents/Options.Organization.html#categorizebygroup

    cleanOutputDir?: boolean

    Prevent TypeDoc from cleaning the output directory specified with --out.

    https://typedoc.org/documents/Options.Output.html#cleanoutputdir

    commentStyle?: CommentStyle

    Specify the documentation mode TypeDoc should use.

    https://typedoc.org/documents/Options.Comments.html#commentstyle

    defaultCategory?: string

    Specify the default category for reflections without a category.

    https://typedoc.org/documents/Options.Organization.html#defaultcategory

    defaultGroup?: string

    Specify the default group for reflections without a group.

    https://typedoc.org/documents/Options.Organization.html#defaultgroup

    defaultVisibility?: Visibility

    Specify the default visibility for members without a visibility tag.

    https://typedoc.org/documents/Options.Comments.html#defaultvisibility

    disableGit?: boolean

    Disables setting the source of reflections when documenting projects within a Git repository.

    https://typedoc.org/documents/Options.Comments.html#disablegit

    disableSources?: boolean

    Disables automatically linking to source code.

    https://typedoc.org/documents/Options.Comments.html#disablesources

    entryPoints?: string[]

    Specifies the entry points to be documented by TypeDoc.

    https://typedoc.org/documents/Options.Input.html#entrypoints

    entryPointStrategy?: EntryPointStrategy

    Specifies the strategy to be used to convert entry points into documentation.

    https://typedoc.org/documents/Options.Input.html#entrypointstrategy

    exclude?: string[]

    Define patterns to be excluded when expanding directories.

    https://typedoc.org/documents/Options.Input.html#exclude

    excludeExternals?: boolean

    Prevent externally resolved symbols from being documented.

    https://typedoc.org/documents/Options.Input.html#excludeexternals

    excludeInternal?: boolean

    Prevent symbols that are not exported from being documented.

    https://typedoc.org/documents/Options.Input.html#excludeinternal

    excludePrivate?: boolean

    Prevent private members from being included in the generated documentation.

    https://typedoc.org/documents/Options.Input.html#excludeprivate

    excludeProtected?: boolean

    Prevent protected members from being included in the generated documentation.

    https://typedoc.org/documents/Options.Input.html#excludeprotected

    externalPattern?: string[]

    Define patterns for files that should be considered external.

    https://typedoc.org/documents/Options.Input.html#externalpattern

    externalSymbolLinkMappings?: Record<string, Record<string, string>>

    Define custom mappings for symbols in external packages.

    https://typedoc.org/documents/Options.Comments.html#externalsymbollinkmappings

    gitRemote?: string

    Specify the git remote that should be used to link to source files.

    https://typedoc.org/documents/Options.Comments.html#gitremote

    gitRevision?: string

    Specify the git revision that should be used to link to source files.

    https://typedoc.org/documents/Options.Comments.html#gitrevision

    hideGenerator?: boolean

    Do not print the TypeDoc link at the end of the page.

    https://typedoc.org/documents/Options.Output.html#hidegenerator

    hideParameterTypesInTitle?: boolean

    Hide parameter types in the signature.

    https://typedoc.org/documents/Options.Output.html#hideparametertypesintitle

    includes?: string

    Specify the location to look for included documents.

    https://typedoc.org/documents/Options.Output.html#includes

    intentionallyNotExported?: string[]

    A list of types that should not produce warnings when not being exported.

    https://typedoc.org/documents/Options.Validation.html#intentionallynotexported

    json?: string

    Specify the location the documentation should be written to.

    https://typedoc.org/documents/Options.Output.html#json

    logLevel?: LogLevel

    Specify the logger that should be used.

    https://typedoc.org/documents/Options.Other.html#loglevel

    media?: string

    Specify the location with media files that should be copied to the output directory.

    https://typedoc.org/documents/Options.Output.html#media

    name?: string

    Set the name of the project that will be used in the header of the template.

    https://typedoc.org/documents/Options.Output.html#name

    out?: string

    Specifies the output directory the documentation should be written to.

    https://typedoc.org/documents/Options.Output.html#out

    packageJson?: string

    Specify the package.json file that should be used to determine the package name.

    https://typedoc.org/documents/Options.Input.html#packagejson

    readme?: string

    Specify the readme file that should be displayed on the index page.

    https://typedoc.org/documents/Options.Input.html#readme

    requiredToBeDocumented?: string[]

    Specify the type of reflections that must be documented.

    https://typedoc.org/documents/Options.Validation.html#requiredtobedocumented

    searchCategoryBoosts?: Record<string, number>

    Specify the search category boosts.

    https://typedoc.org/documents/Options.Organization.html#searchcategoryboosts

    searchGroupBoosts?: Record<string, number>

    Specify the search group boosts.

    https://typedoc.org/documents/Options.Organization.html#searchgroupboosts

    searchInComments?: boolean

    If set, the search index will also include comments.

    https://typedoc.org/documents/Options.Output.html#searchincomments

    searchInDocuments?: boolean

    If set, the search index will also include documents.

    https://typedoc.org/documents/Options.Output.html#searchindocuments

    sort?: string[]

    Specify the sort strategy for documented values.

    https://typedoc.org/documents/Options.Organization.html#sort

    sortEntryPoints?: boolean

    Specify the sort strategy for static and instance members.

    https://typedoc.org/documents/Options.Organization.html#sortentrypoints

    sourceLinkTemplate?: string

    Specify a link template to be used when generating source urls.

    https://typedoc.org/documents/Options.Input.html#sourcelinktemplate

    theme?: string

    Specify a theme name to use.

    https://typedoc.org/documents/Options.Output.html#theme

    treatValidationWarningsAsErrors?: boolean

    If set, validation warnings will be treated as errors.

    https://typedoc.org/documents/Options.Validation.html#treatvalidationwarningsaserrors

    treatWarningsAsErrors?: boolean

    If set, warnings will be treated as errors.

    https://typedoc.org/documents/Options.Validation.html#treatwarningsaserrors

    tsBuildInfo?: string

    Specify the location and filename a .tsbuildinfo file should be written to.

    https://typedoc.org/documents/Options.Input.html#tsbuildinfo

    tsconfig?: string

    Specify a TypeScript config file that should be used to load TypeScript configuration.

    https://typedoc.org/documents/Options.Input.html#tsconfig

    validation?: ValidationOptions

    Specify validation options.

    https://typedoc.org/documents/Options.Validation.html

    Settings

    Member Visibility

    On This Page

    Properties