StorageEvent インターフェイス
StorageEvent インターフェイスは、ストレージと呼ばれるデータの一時保存に変更があると発生するイベントに関するインターフェイスです。
sessionStorage や localStorage といったストレージに関するイベントは storage
です。このイベントで取得する event オブジェクトはストレージに関する情報を含みます。
window.addEventListener('storage', ()=>{
console.log( event.storageArea );
});
StorageEvent インターフェイスは、Event インターフェイスを継承していますので、Event インターフェイスの プロパティ と メソッド が使えます。
- Event
- └── StorageEvent
ストレージとは、データの一時保存の機能のことで、クッキーのようにブラウザにデータの一時的な記録機能です。
ローカルストレージやセッションストレージのことで Web Storage とも呼ばれます。ストレージはクッキーよりも大きな値が記録できます。
記録をブラウザに残すことができるために、作業の途中を記録したり、ユーザー認証に使われたりします。詳しくは Storage インターフェイスを参照してください。
ストレージの使用方法についてはWeb Storage ( sessionStorage, localStorage )
を参照してください。
Constructor
StorageEvent()
StorageEvent オブジェクトを新たに生成します。
Properties
Event インターフェイスを継承していますのでそのプロパティとメソッドが利用できます。
Property | 概要 | |
---|---|---|
.key | window strageのitremのキーをStringで返す | |
.newValue | window strageのitemの新しい値を返す | |
.oldValue | window strageのitemの更新前の値を返す | |
.storageArea | 変更があったwindow strageのitemをStrageオブジェクトで返す | |
.url | 変更があったwindow strageのitemのドキュメントを返す |
関連イベント
StorageEvent オブジェクトは storage(onstorage) イベントを通して利用できるようになります。このオブジェクトのプロパティは event オブジェクトから取得してください。
詳しくは、WindowEventHandlers ミックスインで利用できるイベントとして扱われています。WindowEventHandlers ミックスインを参照してください。
イベントタイプ | 概要 |
---|---|
storage | セッションストレージまたはローカルストレージに変化があったら |