@agds/cli-plugin-doc/lib/types/utils/renderCode.d.ts

agds系统doc文档生成器

export = renderCode;
/**
 * 将codes渲染成md代码片段
 *
 * @memberof GenDoc
 * @param {GetFilesCodeResult[]} codes `GenDoc.getFilesCode`函数获取到的codes数组
 * @param {string[]} [extSort= ['md', 'vue', 'jsx', 'js']] 优先并且按照`extSort`数组顺序获取遍历codes
 * @param {Object<string,string>} [extTrans={vue:'html'}] ext转换的映射map
 * 简单示例`{vue:'html'}`
 * @returns {string}
 */
declare function renderCode(codes: GetFilesCodeResult[], extSort?: string[], extTrans?: {
    [x: string]: string;
}): string;
declare namespace renderCode {
    export { GetFilesCodeResult };
}
/**
 * 获取文件的内容的返回值类型，key是文件的extname
 */
type GetFilesCodeResult = {
    [x: string]: string;
};