UNPKG

1.14 kBTypeScriptView Raw
1export declare enum ParameterHint {
2 File = 0,
3 Directory = 1
4}
5export declare enum ParameterType {
6 String = 0,
7 Number = 1,
8 Boolean = 2,
9 Map = 3,
10 Mixed = 4,
11 Array = 5
12}
13export declare enum ParameterScope {
14 TypeDoc = 0,
15 TypeScript = 1
16}
17export interface DeclarationOption {
18 name: string;
19 component?: string;
20 short?: string;
21 help: string;
22 type?: ParameterType;
23 hint?: ParameterHint;
24 scope?: ParameterScope;
25 map?: 'object' | Map<string | number, any> | {
26 [key: string]: any;
27 };
28 mapError?: string;
29 defaultValue?: any;
30 convert?: (param: OptionDeclaration, value?: any) => any;
31}
32export declare class OptionDeclaration {
33 name: string;
34 component?: string;
35 short?: string;
36 help: string;
37 type: ParameterType;
38 hint?: ParameterHint;
39 scope: ParameterScope;
40 protected map?: {
41 [k: string]: any;
42 } | 'object';
43 mapError?: string;
44 defaultValue: any;
45 constructor(data: DeclarationOption);
46 getNames(): string[];
47 convert(value: unknown, errorCallback?: (format: string, ...args: string[]) => void): any;
48}