YamlEditor
约 1219 字大约 4 分钟
2025-10-13
Karin API Docs / YamlEditor
类: YamlEditor
定义于: packages/core/src/utils/fs/yaml.ts:39
YAML 编辑器
构造函数
构造函数
new YamlEditor(
file):YamlEditor
定义于: packages/core/src/utils/fs/yaml.ts:43
参数
file
string
返回
YamlEditor
属性
doc
doc:
Document
定义于: packages/core/src/utils/fs/yaml.ts:41
document
document:
Document
定义于: packages/core/src/utils/fs/yaml.ts:42
filePath
filePath:
string
定义于: packages/core/src/utils/fs/yaml.ts:40
方法
add()
add(
path,value,isSplit):boolean
定义于: packages/core/src/utils/fs/yaml.ts:87
向指定路径添加新值
参数
path
string
路径，多个路径使用.连接，例如：a.b.c
value
要添加的值
isSplit
boolean = true
是否使用分割路径路径，默认为 true
返回
boolean
append()
append(
path,value,prepend,isSplit):boolean
定义于: packages/core/src/utils/fs/yaml.ts:123
向指定路径的数组添加新值，可以选择添加到数组的开始或结束
参数
path
string
路径，多个路径使用.连接，例如：a.b.c
value
string
要添加的值
prepend
boolean = false
如果为 true，则添加到数组的开头，否则添加到末尾
isSplit
boolean = true
是否使用分割路径路径，默认为 true
返回
boolean
comment()
comment(
path,comment,prepend,isSplit):void
定义于: packages/core/src/utils/fs/yaml.ts:300
设置指定键的注释
参数
path
string
路径，多个路径使用.连接，例如：a.b.c
comment
string
要设置的注释
prepend
boolean = true
如果为 true，则添加注释到开头，否则添加到同一行的末尾
isSplit
boolean = true
是否使用分割路径路径，默认为 true
返回
void
del()
del(
path,isSplit):boolean
定义于: packages/core/src/utils/fs/yaml.ts:105
删除指定路径
参数
path
string
路径，多个路径使用.连接，例如：a.b.c
isSplit
boolean = true
是否使用分割路径路径，默认为 true
返回
boolean
是否删除成功
delarr()
delarr(
index):boolean
定义于: packages/core/src/utils/fs/yaml.ts:254
根据索引从根节点数组删除元素
参数
index
number
要删除元素的索引
返回
boolean
get()
get(
path):any
定义于: packages/core/src/utils/fs/yaml.ts:54
获取指定路径的值
参数
path
string
路径，多个路径使用.连接，例如：a.b.c
返回
any
getcomment()
getcomment(
path,isSplit):any
定义于: packages/core/src/utils/fs/yaml.ts:357
获取指定键的注释
参数
path
string
路径，多个路径使用.连接，例如：a.b.c
isSplit
boolean = true
是否使用分割路径路径，默认为 true
返回
any
getpair()
getpair(
path,isSplit):any
定义于: packages/core/src/utils/fs/yaml.ts:276
获取指定路径的pair对象
参数
path
string
路径，多个路径使用.连接，例如：a.b.c
isSplit
boolean = true
是否使用分割路径路径，默认为 true
返回
any
has()
has(
path,isSplit):boolean
定义于: packages/core/src/utils/fs/yaml.ts:181
检查指定路径的键是否存在
参数
path
string
路径，用点号分隔
isSplit
boolean = true
是否使用分割路径路径，默认为 true
返回
boolean
hascomment()
hascomment(
path,type,isSplit):boolean
定义于: packages/core/src/utils/fs/yaml.ts:339
检查注释是否存在
参数
path
string
路径，多个路径使用.连接，例如：a.b.c
type
要检查的注释类型，before 为注释前，after 为注释后
"before" | "after"
isSplit
boolean = true
是否使用分割路径路径，默认为 true
返回
boolean
hasval()
hasval(
path,value,isSplit):boolean
定义于: packages/core/src/utils/fs/yaml.ts:197
查询指定路径中是否包含指定的值
参数
path
string
路径，用点号分隔
value
要查询的值
isSplit
boolean = true
是否使用分割路径路径，默认为 true
返回
boolean
hasVal()
hasVal(
path,value):boolean
定义于: packages/core/src/utils/fs/yaml.ts:226
查询指定路径中是否包含指定的值
参数
path
string
路径，用点号分隔
value
要查询的值
返回
boolean
已被弃用
请使用 hasval 代替
pusharr()
pusharr(
value):boolean
定义于: packages/core/src/utils/fs/yaml.ts:234
向根节点新增元素，如果根节点不是数组，则将其转换为数组再新增元素
参数
value
要新增的元素
返回
boolean
remove()
remove(
path,value,isSplit):boolean
定义于: packages/core/src/utils/fs/yaml.ts:150
向指定路径的数组删除值
参数
path
string
路径，多个路径使用.连接，例如：a.b.c
value
要删除的值
isSplit
boolean = true
是否使用分割路径路径，默认为 true
返回
boolean
save()
save():
void
定义于: packages/core/src/utils/fs/yaml.ts:368
保存文件 保存失败会抛出异常
返回
void
set()
set(
path,value,isSplit):boolean
定义于: packages/core/src/utils/fs/yaml.ts:70
设置指定路径的值
参数
path
string
路径，多个路径使用.连接，例如：a.b.c
value
要设置的值 允许的类型：string, boolean, number, object, array
isSplit
boolean = true
是否使用分割路径路径，默认为 true
返回
boolean
uncomment()
uncomment(
path,type,isSplit):void
定义于: packages/core/src/utils/fs/yaml.ts:318
删除指定键的注释
参数
path
string
路径，多个路径使用.连接，例如：a.b.c
type
要删除的注释类型，before 为注释前，after 为注释后，all 为全部
"before" | "after" | "all"
isSplit
boolean = true
是否使用分割路径路径，默认为 true
返回
void