このページはコミュニティーの尽力で英語から翻訳されました。MDN Web Docs コミュニティーについてもっと知り、仲間になるにはこちらから。

View in English Always switch to English

storage.StorageArea.onChanged

ストレージ領域内の 1 つ以上のアイテムが変更されたときに発生します。storage.onChanged と比べて、このイベントでは local、managed、session、sync のいずれか 1 つのストレージ領域の変更を監視できます。

メモ: Firefox では、storageArea.set が実行されたストレージ領域のすべてのキーをリスナーが受け取ります。データが変更されていない場合にも、リスナーが呼び出されることがあります。変更されたアイテムの詳細を確認するには、それぞれのキーの storage.StorageChange オブジェクトを調べてください。Firefox バグ 1833153を参照してください。

メモ: Firefox では、storage.managed の変更に対してこのイベントは発生しません。managed ストレージはブラウザーの起動時にのみ読み込まれるためです(JSON マニフェスト(ネイティブマニフェスト)ファイルまたは 3rdparty エンタープライズポリシーから読み込まれます)。

構文

js
// local は sync、managed、session にもできます
browser.storage.local.onChanged.addListener(listener)
browser.storage.local.onChanged.removeListener(listener)
browser.storage.local.onChanged.hasListener(listener)

イベントには次の 3 つの関数があります。

addListener(listener)

このイベントにリスナーを追加します。

removeListener(listener)

このイベントの監視を停止します。listener 引数には、削除するリスナーを指定します。

hasListener(listener)

listener がこのイベントに登録されているかどうかを確認します。監視中の場合は true を返し、それ以外の場合は false を返します。

addListener の構文

引数

listener

このイベントが発生したときに呼び出される関数です。この関数には次の引数が渡されます。

changes

object。変更を説明するオブジェクトです。変更されたキーごとに 1 つのプロパティを含みます。プロパティ名は変更されたキーの名前で、値はそのアイテムへの変更を説明する storage.StorageChange オブジェクトです。

例

js
/*
ローカルストレージで変更されたアイテムの、
変更前と変更後の値をログに出力します。
*/
function logStorageChange(changes) {
  const changedItems = Object.keys(changes);

  for (const item of changedItems) {
    console.log(`${item} has changed:`);
    console.log("Old value: ", changes[item].oldValue);
    console.log("New value: ", changes[item].newValue);
  }
}

browser.storage.local.onChanged.addListener(logStorageChange);

ブラウザーの互換性

メモ: この API は Chromium の chrome.storage(英語) API に基づいています。このドキュメントは、Chromium のコードにある storage.json から派生したものです。