docusaurus-plugin-typedoc-api/lib/types.d.ts

Docusaurus plugin that provides source code API documentation powered by TypeDoc.

import type { JSONOutput, TypeDocOptions } from 'typedoc';
import type { MDXPlugin } from '@docusaurus/mdx-loader';
import type { PropSidebarItem, VersionBanner, VersionsOptions } from '@docusaurus/plugin-content-docs';
export type { VersionBanner };
export interface DocusaurusPluginTypeDocApiOptions extends Omit<VersionsOptions, 'disableVersioning' | 'includeCurrentVersion'> {
    banner?: string;
    breadcrumbs?: boolean;
    changelogName?: string;
    changelogs?: boolean;
    gitRefName?: string;
    debug?: boolean;
    exclude?: string[];
    id?: string;
    minimal?: boolean;
    packageJsonName?: string;
    packages: (PackageConfig | string)[];
    projectRoot: string;
    readmeName?: string;
    readmes?: boolean;
    removeScopes?: string[];
    sortPackages?: (a: PackageReflectionGroup, d: PackageReflectionGroup) => number;
    sortSidebar?: (a: string, d: string) => number;
    tsconfigName?: string;
    typedocOptions?: Partial<TypeDocOptions>;
    remarkPlugins: MDXPlugin[];
    rehypePlugins: MDXPlugin[];
    disableVersioning?: boolean;
    includeCurrentVersion?: boolean;
    routeBasePath?: string;
}
export interface PackageEntryConfig {
    label: string;
    path: string;
}
export interface PackageConfig {
    path: string;
    entry?: Record<string, PackageEntryConfig | string> | string;
    slug?: string;
}
export interface ResolvedPackageConfig {
    entryPoints: Record<string, PackageEntryConfig>;
    packageRoot: string;
    packagePath: string;
    packageSlug: string;
    packageName: string;
    packageVersion: string;
}
export interface VersionMetadata {
    versionName: string;
    versionLabel: string;
    versionPath: string;
    versionBadge: boolean;
    versionBanner: VersionBanner | null;
    versionClassName: string;
    isLast: boolean;
    routePriority: number | undefined;
}
export interface LoadedVersion extends VersionMetadata {
    packages: PackageReflectionGroup[];
    sidebars: SidebarItem[];
}
export interface LoadedContent {
    loadedVersions: LoadedVersion[];
}
export type SidebarItem = PropSidebarItem;
export interface ApiOptions {
    banner: string;
    breadcrumbs: boolean;
    gitRefName: string;
    minimal: boolean;
    pluginId: string;
    scopes: string[];
}
export interface TOCItem {
    readonly value: string;
    readonly id: string;
    readonly level: number;
}
export interface PackageReflectionGroupEntry {
    index: boolean;
    label: string;
    reflection: TSDDeclarationReflection;
    urlSlug: string;
}
export interface PackageReflectionGroup {
    entryPoints: PackageReflectionGroupEntry[];
    packageName: string;
    packageVersion: string;
    changelogPath?: string;
    readmePath?: string;
}
export interface ApiMetadata {
    id: number;
    name: string;
    permalink: string;
    previousId?: number;
    nextId?: number;
}
export interface TSDReflection extends Omit<JSONOutput.Reflection, 'signatures'>, ApiMetadata {
    signatures: TSDSignatureReflection[];
    parentId?: number;
}
export interface TSDDeclarationReflection extends Omit<JSONOutput.DeclarationReflection, 'children' | 'signatures'>, ApiMetadata {
    children?: TSDDeclarationReflection[];
    signatures: TSDSignatureReflection[];
}
export type TSDDeclarationReflectionMap = Record<number, TSDDeclarationReflection>;
export interface TSDSignatureReflection extends JSONOutput.SignatureReflection {
}
declare global {
    var typedocBuild: {
        count: number;
    };
}
//# sourceMappingURL=types.d.ts.map