@bitjson/typedoc/dist/lib/utils/options/declaration.d.ts

Create api documentation for TypeScript projects.

export declare enum ParameterHint {
    File = 0,
    Directory = 1
}
export declare enum ParameterType {
    String = 0,
    Number = 1,
    Boolean = 2,
    Map = 3,
    Mixed = 4,
    Array = 5
}
export declare enum ParameterScope {
    TypeDoc = 0,
    TypeScript = 1
}
export interface DeclarationOption {
    name: string;
    component?: string;
    short?: string;
    help: string;
    type?: ParameterType;
    hint?: ParameterHint;
    scope?: ParameterScope;
    map?: 'object' | Map<string | number, any> | {
        [key: string]: any;
    };
    mapError?: string;
    defaultValue?: any;
    convert?: (param: OptionDeclaration, value?: any) => any;
}
export declare class OptionDeclaration {
    name: string;
    component?: string;
    short?: string;
    help: string;
    type: ParameterType;
    hint?: ParameterHint;
    scope: ParameterScope;
    protected map?: {
        [k: string]: any;
    } | 'object';
    mapError?: string;
    defaultValue: any;
    constructor(data: DeclarationOption);
    getNames(): string[];
    convert(value: unknown, errorCallback?: (format: string, ...args: string[]) => void): any;
}