lemon-devkit/dist/proxy-docs/install.d.ts

Lemon Serverless Micro-Service Platform for local development

export interface InstallProxyDocsOptions {
    /** consumer project root. Usually npm lifecycle INIT_CWD. */
    projectRoot: string;
    /** package root where docs/proxy-implementation-guide.md exists. */
    packageRoot: string;
    /** overwrite docs/proxy-implementation-guide.md when the packaged source changes. default true */
    overwrite?: boolean;
}
export interface InstallProxyDocsResult {
    copied: boolean;
    readmeUpdated: boolean;
    proxyDocPath: string;
    readmePath: string;
}
export declare const proxyReadmeBlock: (docRelPath?: string) => string;
export declare const upsertProxyReadmeBlock: (readme: string, docRelPath?: string) => string;
export declare const installProxyDocs: (options: InstallProxyDocsOptions) => InstallProxyDocsResult;