備忘録的プログラミングリファレンス

StorageEvent インターフェイス

 StorageEvent インターフェイスは、ストレージと呼ばれるデータの一時保存の機能に変更があると発生するイベントに関するインターフェイスです。

 StorageEvent オブジェクトを返すのは、イベントハンドラー onstorage を利用したときです。取得した event オブジェクトを通してこのプロパティを利用できます。
 イベントタイプ名は storage です。

storage イベントのハンドラー設定
window.addEventListener('storage', ()=>{
	console.log( event.storageArea );
});

 StorageEvent インターフェイスは、Event インターフェイスを継承していますので、Event インターフェイスの プロパティ と メソッド が使えます。

StorageEvent継承図
  • Event
    • └── StorageEvent

 ストレージとは、ローカルストレージやセッションストレージのことで Web Storage とも呼ばれます。 データの一時保存の機能のことで、クッキーのようにブラウザにデータの一時的な記録機能です。ストレージはクッキーよりも大きな値が記録できます。
 記録をブラウザに残すことができるために、作業の途中を記録したり、ユーザー認証に使われたりします。詳しくは Storage インターフェイスを参照してください。

Constructor

StorageEvent()

 StorageEvent オブジェクトを新たに生成します。

Properties

 Event インターフェイスを継承していますのでそのプロパティとメソッドが利用できます。

Property概要
.keywindow strageのitremのキーをStringで返す 
.newValuewindow strageのitemの新しい値を返す 
.oldValuewindow strageのitemの更新前の値を返す 
.storageArea変更があったwindow strageのitemをStrageオブジェクトで返す 
.url変更があったwindow strageのitemのドキュメントを返す 

関連イベント

 StorageEvent オブジェクトは storage(onstorage) イベントを通して利用できるようになります。このオブジェクトのプロパティは event オブジェクトから取得してください。

 詳しくは、WindowEventHandlers ミックスインで利用できるイベントとして扱われています。WindowEventHandlers ミックスインを参照してください。

イベントタイプ概要
storageセッションストレージまたはローカルストレージに変化があったら