UNPKG

1.09 kBTypeScriptView Raw
1import type { OptionsReader } from "../options.js";
2import type { Logger } from "../../loggers.js";
3import type { Options } from "../options.js";
4/**
5 * Obtains option values from typedoc.json
6 */
7export declare class TypeDocReader implements OptionsReader {
8 /**
9 * Should run before the tsconfig reader so that it can specify a tsconfig file to read.
10 */
11 order: number;
12 name: string;
13 supportsPackages: boolean;
14 /**
15 * Read user configuration from a typedoc.json or typedoc.js configuration file.
16 */
17 read(container: Options, logger: Logger, cwd: string): Promise<void>;
18 /**
19 * Read the given options file + any extended files.
20 * @param file
21 * @param container
22 * @param logger
23 */
24 private readFile;
25 /**
26 * Search for the configuration file given path
27 *
28 * @param path Path to the typedoc.(js|json) file. If path is a directory
29 * typedoc file will be attempted to be found at the root of this path
30 * @returns the typedoc.(js|json) file path or undefined
31 */
32 private findTypedocFile;
33}