mfdoc/build/src/doc.d.ts

Auto generate JS SDK and HTTP API documentation

export declare class Doc {
    protected props: {
        genTypesFilepath: string;
    };
    protected disclaimer: string;
    protected endpointsText: string;
    protected typesText: string;
    protected docImports: Record<string, {
        importing: string[];
        from: string;
    }>;
    protected docTypeImports: Record<string, {
        importing: string[];
        from: string;
    }>;
    protected classes: Record<string, {
        entries: string[];
        name: string;
        extendsName?: string;
    }>;
    generatedTypeCache: Map<string, boolean>;
    constructor(props: {
        genTypesFilepath: string;
    });
    appendType(typeText: string): this;
    appendEndpoint(endpoint: string): this;
    appendImport(importing: Array<string>, from: string): this;
    appendTypeImport(importing: Array<string>, from: string): this;
    appendImportFromGenTypes(importing: string[]): this;
    appendToClass(entry: string, name: string, extendsName?: string): this;
    compileText(): string;
    protected compileImports(): string;
    protected compileTypeImports(): string;
    protected compileClasses(): string;
}