Karin API Docs / DefineConfig

接口: DefineConfig\<T\>

定义于: packages/core/src/types/server/local.ts:80

webui配置

类型参数

T

T = any

属性

components()?

optional components: () => ComponentConfig[] | Promise<ComponentConfig[]>

定义于: packages/core/src/types/server/local.ts:97

默认组件配置参数

返回

ComponentConfig[] | Promise<ComponentConfig[]>

---

customComponent()?

optional customComponent: () => unknown

定义于: packages/core/src/types/server/local.ts:108

自定义组件配置

返回

unknown

Description

未完成

---

info

info: object

定义于: packages/core/src/types/server/local.ts:82

插件信息

author?

optional author: Author | Author[]

插件作者

description?

optional description: string

插件描述 可不填 会自动读取package.json中的version

icon?

optional icon: Icon

插件图标 前端优先展示

id

id: string

插件id 也就是插件的包名

name?

optional name: string

插件名称 前端优先展示

version?

optional version: string

插件版本 可不填 会自动读取package.json中的version

---

save()?

optional save: (config) => SaveConfigResponse | Promise<SaveConfigResponse>

定义于: packages/core/src/types/server/local.ts:103

保存配置

参数

config

T

配置

返回

SaveConfigResponse | Promise<SaveConfigResponse>

保存结果