@alicloud/console-toolkit-plugin-docs/lib/loaders/type-info-loader/collectInterfaceInfo.d.ts

console toolkit plugin for build docs

interface InterfaceInfo {
    name: string;
    documentation: string;
    properties: InterfacePropertyInfo[];
}
interface InterfacePropertyInfo {
    name: string;
    typeText: string;
    documentation: string;
    defaultValue?: string;
}
export declare function collectInterfaceInfo(fileName: string): InterfaceInfo;
export {};
/**
 * ref:
 *
 * https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API
 *
 * https://stackoverflow.com/questions/59838013/how-can-i-use-the-ts-compiler-api-to-find-where-a-variable-was-defined-in-anothe
 *
 * https://stackoverflow.com/questions/60249275/typescript-compiler-api-generate-the-full-properties-arborescence-of-a-type-ide
 *
 * https://stackoverflow.com/questions/47429792/is-it-possible-to-get-comments-as-nodes-in-the-ast-using-the-typescript-compiler
 *
 * Instructions of learning ts compiler:
 * https://stackoverflow.com/a/58885450
 *
 * https://learning-notes.mistermicheels.com/javascript/typescript/compiler-api/
 */