UNPKG

1.18 kBTypeScriptView Raw
1import { JsonSchema, NewlineKind } from '@rushstack/node-core-library';
2import type { IConfigFile } from './IConfigFile';
3/**
4 * Helper for loading the api-documenter.json file format. Later when the schema is more mature,
5 * this class will be used to represent the validated and normalized configuration, whereas `IConfigFile`
6 * represents the raw JSON file structure.
7 */
8export declare class DocumenterConfig {
9 readonly configFilePath: string;
10 readonly configFile: IConfigFile;
11 /**
12 * Specifies what type of newlines API Documenter should use when writing output files. By default, the output files
13 * will be written with Windows-style newlines.
14 */
15 readonly newlineKind: NewlineKind;
16 /**
17 * The JSON Schema for API Documenter config file (api-documenter.schema.json).
18 */
19 static readonly jsonSchema: JsonSchema;
20 /**
21 * The config file name "api-documenter.json".
22 */
23 static readonly FILENAME: string;
24 private constructor();
25 /**
26 * Load and validate an api-documenter.json file.
27 */
28 static loadFile(configFilePath: string): DocumenterConfig;
29}
30//# sourceMappingURL=DocumenterConfig.d.ts.map
\No newline at end of file