Karin API Docs / yaml

变量: yaml

const yaml: __module & object

定义于: packages/core/src/utils/fs/yaml.ts:479

YAML 工具

类型声明

applyComments()

applyComments: (editor, comments) => void

批量添加注释

批量添加注释

参数

editor

YamlEditor

YamlEditor 实例

comments

YamlComment

注释配置对象

返回

void

comment()

comment: (filePath, commentConfig) => void

为指定文件写入注释

为指定文件写入注释

参数

filePath

string

文件路径

commentConfig

注释配置文件路径或 JSON 对象

string | YamlComment

返回

void

read

read: ReadFunction

读取并解析 YAML 文件

save

save: Save

保存数据并写入注释