UNPKG

1.04 kBTypeScriptView Raw
1/**
2 * Configuration for declaration generation.
3 */
4export interface Config {
5 /**
6 * Skip source files whose paths match any of these glob patterns. If
7 * undefined, defaults to excluding directories ending in "test" or "demo".
8 */
9 exclude?: string[];
10 /**
11 * Remove any triple-slash references to these files, specified as paths
12 * relative to the analysis root directory.
13 */
14 removeReferences?: string[];
15 /**
16 * Additional files to insert as triple-slash reference statements. Given the
17 * map `a: b[]`, a will get an additional reference statement for each file
18 * path in b. All paths are relative to the analysis root directory.
19 */
20 addReferences?: {
21 [filepath: string]: string[];
22 };
23}
24/**
25 * Analyze all files in the given directory using Polymer Analyzer, and return
26 * TypeScript declaration document strings in a map keyed by relative path.
27 */
28export declare function generateDeclarations(rootDir: string, config: Config): Promise<Map<string, string>>;