import { JsonSchema, NewlineKind } from '@rushstack/node-core-library'; import { IConfigFile } from './IConfigFile'; import { DocGenMode } from './DocGenMode'; import { MarkdownHeadingLevel } from '../markdown/MarkdownHeadingLevel'; /** * Helper for loading the api-documenter.json file format. Later when the schema is more mature, * this class will be used to represent the validated and normalized configuration, whereas `IConfigFile` * represents the raw JSON file structure. */ export declare class DocumenterConfig { readonly configFilePath: string; readonly configFile: IConfigFile; /** * Specifies what type of newlines API Documenter should use when writing output files. By default, the output files * will be written with Windows-style newlines. */ readonly newlineKind: NewlineKind; /** * Specifies a custom URI root in case the documentation links should be customized. */ uriRoot?: string; /** * Specifies how packages must start to be included, so non matching package names are excluded. */ onlyPackagesStartingWith?: string | string[]; /** * Specifies the log level to output. */ logLevel?: string; /** * Adds a fixed suffix to the output filenames. */ readonly outputFileNameSuffix?: string; /** * {@inheritDoc IConfigFile.mode} */ readonly rootHeadingLevel?: MarkdownHeadingLevel; /** * {@inheritDoc IConfigFile.mode} */ readonly mode?: DocGenMode; /** * The JSON Schema for API Extractor config file (api-extractor.schema.json). */ static readonly jsonSchema: JsonSchema; /** * The config file name "api-extractor.json". */ static readonly FILENAME: string; private constructor(); /** * Load and validate an api-documenter.json file. */ static loadFile(configFilePath: string): DocumenterConfig; } //# sourceMappingURL=DocumenterConfig.d.ts.map