API
template-sdk 提供了一套简洁而强大的 API,涵盖了配置定义、构建处理和运行时取值等核心功能。
SDK 入口
SDK 通过以下方式导入:
// 默认导入(包含 Vue 插件和所有导出)
import TemplateSdk from 'template-sdk'
// 按需导入
import { useTemplateValue, validateTemplateConfig } from 'template-sdk'
模块导出
template-sdk
SDK 的主入口,导出运行时所需的全部 API:
| 导出 | 说明 | 类型 |
|---|---|---|
TemplateSdk |
Vue 插件 | Plugin |
useTemplateValue |
组合式函数,用于读取字段值 | Function |
validateTemplateConfig |
配置校验函数 | Function |
buildTemplateValueMap |
构建 valueMap | Function |
buildTemplateArtifacts |
构建完整产物 | Function |
buildTemplateJsonFiles |
构建 JSON 文件 | Function |
template-sdk/config
配置相关的 API:
| 导出 | 说明 | 类型 |
|---|---|---|
defineTemplateConfig |
类型安全的配置定义函数 | Function |
template-sdk/vite
Vite 插件相关的 API:
| 导出 | 说明 | 类型 |
|---|---|---|
templateSdkPlugin |
Vite 插件 | Plugin |