@microsoft/api-documenter/lib/documenters/DocumenterConfig.d.ts

Read JSON files from api-extractor, generate documentation pages

import { JsonSchema, NewlineKind } from '@rushstack/node-core-library';
import type { IConfigFile } from './IConfigFile';
/**
 * 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;
    /**
     * The JSON Schema for API Documenter config file (api-documenter.schema.json).
     */
    static readonly jsonSchema: JsonSchema;
    /**
     * The config file name "api-documenter.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