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

agds系统doc文档生成器

export = jsdocRender;
/**
 *  渲染jsdoc文档
 *
 * @param {Jsdoc2mdOptions} options jsdocToMarkdown配置参数
 * @returns {Promise<string>} 异步返回jsdoc文档文本
 * @ignore
 */
declare function jsdocRender(options: Jsdoc2mdOptions): Promise<string>;
declare namespace jsdocRender {
    export { Jsdoc2mdOptions, DataModifySupport, DataModify };
}
/**
 * jsdocToMarkdown配置参数，具体可[👉参考文档](https://github.com/jsdoc2md/jsdoc-to-markdown/blob/master/docs/API.md)
 */
type Jsdoc2mdOptions = import('jsdoc-to-markdown').JsdocOptions | import('jsdoc-to-markdown').RenderOptions | DataModifySupport;
/**
 * 在原有Jsdoc2mdOptions基础上扩展dataModify属性，支持修改templateData
 */
type DataModifySupport = {
    dataModify: DataModify;
};
type DataModify = (doclets: object[]) => object[];