TypeDoc API - v0.28.1

    Interface TypeDocPackageOptions

    Describes TypeDoc options suitable for setting within the packageOptions setting.

    This is a subset of all options specified in TypeDocOptions.

    interface TypeDocPackageOptions {
        alwaysCreateEntryPointModule?: boolean;
        basePath?: string;
        blockTags?: `@${string}`[];
        cascadedModifierTags?: `@${string}`[];
        categorizeByGroup?: boolean;
        categoryOrder?: string[];
        commentStyle?:
            | "jsdoc"
            | "block"
            | "line"
            | "all"
            | "All"
            | "JSDoc"
            | "Block"
            | "Line";
        compilerOptions?: unknown;
        defaultCategory?: string;
        disableGit?: boolean;
        disableSources?: boolean;
        emit?: "none"
        | "both"
        | "docs";
        entryPoints?: string[];
        entryPointStrategy?:
            | "Expand"
            | "expand"
            | "resolve"
            | "packages"
            | "merge"
            | "Resolve"
            | "Packages"
            | "Merge";
        exclude?: string[];
        excludeCategories?: string[];
        excludeExternals?: boolean;
        excludeInternal?: boolean;
        excludeNotDocumented?: boolean;
        excludeNotDocumentedKinds?: KindString[];
        excludePrivate?: boolean;
        excludeProtected?: boolean;
        excludeReferences?: boolean;
        excludeTags?: `@${string}`[];
        externalPattern?: string[];
        externalSymbolLinkMappings?: Record<string, Record<string, string>>;
        gitRemote?: string;
        gitRevision?: string;
        groupOrder?: string[];
        groupReferencesByType?: boolean;
        includeVersion?: boolean;
        inlineTags?: `@${string}`[];
        intentionallyNotDocumented?: string[];
        intentionallyNotExported?: string[];
        jsDocCompatibility?: boolean | Partial<Configuration.JsDocCompatibility>;
        kindSortOrder?: KindString[];
        maxTypeConversionDepth?: number;
        modifierTags?: `@${string}`[];
        name?: string;
        options?: string;
        packagesRequiringDocumentation?: string[];
        preserveLinkText?: boolean;
        projectDocuments?: string[];
        readme?: string;
        requiredToBeDocumented?: KindString[];
        skipErrorChecking?: boolean;
        sort?: (
            | "kind"
            | "source-order"
            | "alphabetical"
            | "alphabetical-ignoring-documents"
            | "enum-value-ascending"
            | "enum-value-descending"
            | "enum-member-source-order"
            | "static-first"
            | "instance-first"
            | "visibility"
            | "required-first"
            | "external-last"
            | "documents-first"
            | "documents-last"
        )[];
        sortEntryPoints?: boolean;
        sourceLinkTemplate?: string;
        suppressCommentWarningsInDeclarationFiles?: boolean;
        tsconfig?: string;
        useTsLinkResolution?: boolean;
        validation?: boolean
        | Partial<Configuration.ValidationOptions>;
    }

    Hierarchy

    Index

    Properties

    alwaysCreateEntryPointModule?: boolean
    basePath?: string
    blockTags?: `@${string}`[]
    cascadedModifierTags?: `@${string}`[]
    categorizeByGroup?: boolean
    categoryOrder?: string[]
    commentStyle?:
        | "jsdoc"
        | "block"
        | "line"
        | "all"
        | "All"
        | "JSDoc"
        | "Block"
        | "Line"
    compilerOptions?: unknown
    defaultCategory?: string
    disableGit?: boolean
    disableSources?: boolean
    emit?: "none" | "both" | "docs"
    entryPoints?: string[]
    entryPointStrategy?:
        | "Expand"
        | "expand"
        | "resolve"
        | "packages"
        | "merge"
        | "Resolve"
        | "Packages"
        | "Merge"
    exclude?: string[]
    excludeCategories?: string[]
    excludeExternals?: boolean
    excludeInternal?: boolean
    excludeNotDocumented?: boolean
    excludeNotDocumentedKinds?: KindString[]
    excludePrivate?: boolean
    excludeProtected?: boolean
    excludeReferences?: boolean
    excludeTags?: `@${string}`[]
    externalPattern?: string[]
    externalSymbolLinkMappings?: Record<string, Record<string, string>>
    gitRemote?: string
    gitRevision?: string
    groupOrder?: string[]
    groupReferencesByType?: boolean
    includeVersion?: boolean
    inlineTags?: `@${string}`[]
    intentionallyNotDocumented?: string[]
    intentionallyNotExported?: string[]
    jsDocCompatibility?: boolean | Partial<Configuration.JsDocCompatibility>
    kindSortOrder?: KindString[]
    maxTypeConversionDepth?: number
    modifierTags?: `@${string}`[]
    name?: string
    options?: string
    packagesRequiringDocumentation?: string[]
    preserveLinkText?: boolean
    projectDocuments?: string[]
    readme?: string
    requiredToBeDocumented?: KindString[]
    skipErrorChecking?: boolean
    sort?: (
        | "kind"
        | "source-order"
        | "alphabetical"
        | "alphabetical-ignoring-documents"
        | "enum-value-ascending"
        | "enum-value-descending"
        | "enum-member-source-order"
        | "static-first"
        | "instance-first"
        | "visibility"
        | "required-first"
        | "external-last"
        | "documents-first"
        | "documents-last"
    )[]
    sortEntryPoints?: boolean
    sourceLinkTemplate?: string
    suppressCommentWarningsInDeclarationFiles?: boolean
    tsconfig?: string
    useTsLinkResolution?: boolean
    validation?: boolean | Partial<Configuration.ValidationOptions>
    MMNEPVFCICPMFPCPTTAAATR