tag（タグ）

eagle.tag APIを通じて、現在のアプリケーション内のタグに簡単にアクセスできます。

// すべてのタグを取得
const tags = await eagle.tag.get();

// 名前でタグをフィルタリング
const designTags = await eagle.tag.get({ name: "design" });

// 最近使用されたタグを取得
const recents = await eagle.tag.getRecentTags();

// お気に入りタグを取得
const starred = await eagle.tag.getStarredTags();

メソッド

get(options)

タグを取得します。オプションでフィルタリングが可能です。

• options Object (オプション) - クエリ条件

  • name string (オプション) - タグ名で曖昧検索、大文字小文字を区別しない

• 戻り値 Promise<tags: Object[]> - タグのクエリ結果。

// すべてのタグを取得
const tags = await eagle.tag.get();

// 名前でタグをフィルタリング
const filteredTags = await eagle.tag.get({
    name: "design"
});

ヒント：name パラメータは Eagle 4.0 build12 以上のバージョンが必要です。

---

getRecentTags()

最近使用されたタグを取得します。

• 戻り値 Promise<tags: Object[]> - タグのクエリ結果。

const recents = await eagle.tag.getRecentTags();

---

getStarredTags()

お気に入りタグ（ユーザーがスターを付けたタグ）を取得します。

• 戻り値 Promise<tags: Object[]> - タグのクエリ結果。

const starred = await eagle.tag.getStarredTags();

ヒント：getStarredTags() メソッドは Eagle 4.0 build18 以上のバージョンが必要です。

---

merge(options)

タグをマージします：ソースタグをターゲットタグに名前変更し、ソースタグを使用しているすべてのアイテムを自動的に更新します。

• options Object - オプションパラメータ

  • source string - ソースタグ名（削除されます）

  • target string - ターゲットタグ名（マージ後に保持されます）

• 戻り値 Promise<Object> - マージ結果

  • affectedItems number - 影響を受けたアイテム数

  • sourceRemoved boolean - ソースタグが削除されたかどうか

// すべての "UI Design" タグを "UI" にマージ
const result = await eagle.tag.merge({
    source: 'UI Design',
    target: 'UI'
});

console.log(`${result.affectedItems} 個のアイテムのタグをマージしました`);

ヒント：merge() メソッドは Eagle 4.0 build18 以上のバージョンが必要です。

注意：マージ操作は、ソースタグを使用しているすべてのアイテム、タググループ、お気に入りタグ、履歴タグを更新します。この操作は元に戻せません。

---

クラス：Tag

Eagle API get によって返されるオブジェクトタイプで、変更・保存機能を提供します。

🦄 ベストプラクティス： データの安全性を確保するため、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();

ヒント：save() メソッドは Eagle 4.0 build12 以上のバージョンが必要です。

注意：タグ名を変更すると、そのタグを使用しているすべてのファイルが自動的に新しいタグ名に更新されます。

---

インスタンスプロパティ

name string

タグ名。このプロパティを変更して save() メソッドで保存できます。

count number

読み取り専用、このタグを使用しているファイルの数。

color string

タグの色。

groups string[]

読み取り専用、タグが属するグループ。

pinyin string

読み取り専用、タグ名のピンイン（検索とソート用）。