import { EntryPointStrategy, TypeDocOptions } from 'typedoc'; /** * A builder for TypeDoc configurations. */ export declare class ZTypedocConfigBuilder { static readonly OutputDist = "./dist"; static readonly EntryPointIndex = "./src/index.mts"; private typedoc; /** * Sets the output directory for the documentation. * * @param path - * The output directory path. * @returns * This object. */ out(path: string): this; /** * Sets the output directory to "./dist". * * @returns * This object. */ dist: () => this; /** * Adds a list of entry point glob to the existing entry points. * * @param glob - * The entry point glob pattern. * * @returns * This object. */ entry(glob: string): this; /** * Adds an entry point for './src/index.ts'. * * @returns * This object. */ index: () => this; /** * Sets the entry point strategy. * * See {@link https://typedoc.org/api/enums/EntryPointStrategy.html | EntryPointStrategy} * for more details. * * @param strategy - * The entry point strategy to use. * * @returns * This object. */ entryPointStrategy(strategy: EntryPointStrategy): this; /** * Sets the entry point strategy to "resolve". * * @returns * This object. */ resolve: () => this; /** * Sets the entry point strategy to "packages". * * @returns * This object. */ packages: () => this; /** * Sets the excludeNotDocumented flag. * * @returns * This object. */ excludeNotDocumented(): this; /** * Sets the categorizeByGroup flag. * * @returns * This object. */ categorizeByGroup(): this; /** * Sets the name of the project. * * @param name - * The name of the project. * * @returns * This object. */ name(name: string): this; /** * Sets the favicon for the project. * * @param path - * The path to the favicon file. * * @returns * This object. */ favicon(path: string): this; /** * Adds a single exclude glob to the existing excludes. * * @param glob - * The exclude glob pattern. * * @returns * This object. */ exclude(glob: string | string[]): this; /** * Sets the typedoc configuration to be used for an individual project. * * An individual project typedoc does not output any documentation by itself, * but is part of a larger project that does. * * @returns * This object. */ project(): this; /** * Sets the typedoc configuration to be used a web project that outputs * final documentation for a monorepo of packages. * * Normally, your monorepo will have a single web or doc project that outputs * the typescript for every package in the monorepo. Use this configuration * for that project. * * @returns * This object. */ web(): this; /** * Builds the final typedoc configuration object. * * @returns * The final typedoc configuration object. */ build(): TypeDocOptions; }