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唯讀,標籤名稱的拼音(用於搜尋和排序)。
Last updated