StorageArea.getKeys()
ストレージ領域内のすべてのアイテムのキーを取得します。
構文
js
let results = browser.storage.<storageType>.getKeys();
引数
このメソッドに引数はありません。
返値
ストレージアイテムのキーを含む配列で履行される Promise です。
操作に失敗した場合、このプロミスはエラーメッセージとともに拒否されます。
managed ストレージが設定されていない場合、undefined が返されます。
警告:
Firefox では、拡張機能の managed ストレージが ネイティブマニフェストまたは 3rdparty エンタープライズポリシーで設定されていない場合、この関数で managed ストレージにアクセスすると例外が発生します(Firefox バグ 1868153を参照)。エラーを捕捉すれば、この問題を回避できます。この問題は、マニフェストキー storage.managed_schema に対応していないことに関連しています(Firefox バグ 1771731を参照)。
例
ストレージに次の 2 つのアイテムが格納されているとします。
js
// ストレージには "kitten" と "monster" の 2 つのアイテムが格納されています
browser.storage.local.set({
kitten: { name: "Mog", eats: "mice" },
monster: { name: "Kraken", eats: "people" },
});
storage.local 内のすべてのアイテムのキーを取得し、結果をログに出力します。
js
browser.storage.local
.getKeys()
.then((keys) => console.log(keys)) // [ "kitten", "monster" ]
.catch((err) => console.error(`Error: ${err}`));