@es-pkg/doc

根据ts文件的注释生成表格md

🔧 Install

npm install @es-pkg/doc

🔖 bootstrap

类型：typeof bootstrap

简介：无说明

🔖 setup

类型：typeof setup

简介：无说明

🔖 bootstrap

类型：typeof bootstrap

简介：默认 EsPkgDoc的主函数

🔖 PropertiesDoc

类型：PropertiesDoc

简介：无说明

⚙️ API 参数

| 属性 | 说明 | 类型 | 默认值 | | ---------- | -- | ------------ | --- | | name | | string | | | isOptional | | ?: boolean | | | type | | string | | | docs | | JSDoc\[\] | |

🔖 JSDocTag

类型：JSDocTag

简介：无说明

⚙️ API 参数

| 属性 | 说明 | 类型 | 默认值 | | ---- | -- | ------------ | --- | | tag | | string, | | | name | | ?: string, | | | text | | string | |

🔖 JSDoc

类型：JSDoc

简介：无说明

⚙️ API 参数

| 属性 | 说明 | 类型 | 默认值 | | ----------- | -- | --------------- | --- | | comment | | string | | | description | | string | | | tags | | JSDocTag\[\] | |

🔖 Exports

类型：Exports

简介：无说明

⚙️ API 参数

| 属性 | 说明 | 类型 | 默认值 | | --------------- | -- | ---------------- | --- | | component | | ComponentMsg, | | | name | | string, | | | doc | | JSDoc\[\], | | | isDefaultExport | | boolean, | | | type | | string, | | | kind | | string | |

🔖 ToExports

类型：ToExports

简介：无说明

🔖 ComponentMsg

类型：ComponentMsg

简介：无说明

⚙️ API 参数

| 属性 | 说明 | 类型 | 默认值 | | ------------- | -- | ---------------------- | --- | | isReact | | boolean | | | props | | ?: Type | | | ref | | ?: Type, | | | properties | | ?: PropertiesDoc\[\] | | | refProperties | | ?: PropertiesDoc\[\] | |

🔖 DocOptions

类型：DocOptions

简介：生成doc文档的配置项

⚙️ API 参数

| 属性 | 说明 | 类型 | 默认值 | | ------------- | ---------------- | ---------------------------------------- | -------- | | name | 包名称 | ?: string, | | | author | 作者 | ?: string, | | | repository | 仓库地址 | ?: string, | | | desc | 描述 | ?: string | | | entry | 编译文件的入口 | string, | | | tsconfig | 编译文件的 ts配置路径 | ?: string, | | | outDir | 编译后输出的文件夹 | string, | | | outType | 编译后输出的类型 | ?: "html" \| "md" \| \["html", "md"\], | md | | outName | 编译后输出的文件名称 | ?: string, | README | | keepHtmlTable | 是否保留为原始htmlTable | ?: boolean | false |