tag(标签)
透过 eagle.tag API 可以方便存取当前应用中的标签。
// 取得所有标签
const tags = await eagle.tag.get();
// 按名称筛选标签
const designTags = await eagle.tag.get({ name: "design" });
// 取得最近使用标签
const recents = await eagle.tag.getRecents();
方法
get(options)
获取标签,可通过选项进行筛选。
options
Object (可选) - 查询条件name
string (可选) - 按标签名称进行模糊搜索,不区分大小写
返回
Promise<tags: Object[]>
- tags 查询结果。
// 获取所有标签
const tags = await eagle.tag.get();
// 按名称筛选标签
const filteredTags = await eagle.tag.get({
name: "design"
});
getRecents()
获取最近使用的的标签。
返回
Promise<tags: Object[]>
- tags 查询结果。
const recents = (await eagle.tag.getRecents());
类:Tag
由 Eagle API get
返回的 Object 类型,提供修改、保存功能。
🦄 最佳实践: 为了确保数据安全性,请使用 Tag 实例提供的 save()
方法进行数据的修改,应避免直接修改 Eagle 资源库底下的标签数据。
实例方法
save()
保存标签的修改。目前仅支持修改标签名称。
返回
Promise<result: boolean>
-result
是否修改成功
// 获取所有标签
const tags = await eagle.tag.get();
// 找到要修改的标签
const tag = tags.find(t => t.name === 'old-name');
// 修改标签名称
tag.name = 'new-name';
// 保存修改
await tag.save();
注意:修改标签名称后,所有使用该标签的文件都会自动更新为新的标签名称。
实例属性
name
string
name
string标签名称。可修改此属性并通过 save()
方法保存。
count
number
count
number只读,使用此标签的文件数量。
color
string
color
string标签颜色。
groups
string[]
groups
string[]只读,标签所属的分组。
pinyin
string
pinyin
string只读,标签名称的拼音(用于搜索和排序)。
最后更新于