StorageEvent: StorageEvent() constructor

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨April 2018⁩.

The StorageEvent() constructor creates a new StorageEvent object.

Syntax

js
new StorageEvent(type)
new StorageEvent(type, options)

Parameters

type

A string with the name of the type of the StorageEvent. It is case-sensitive and browsers set it to storage.

options Optional

An object that, in addition of the properties defined in Event(), has the following properties:

key Optional

A string that represents the key for the storage item that changed. Defaults to null.

oldValue Optional

A string containing the original value of the storage item. Defaults to null.

newValue Optional

A string with the new value of the key. Defaults to null.

url

A string with the URL of the document whose storage changed.

storageArea Optional

A Storage object that represents the storage that was affected. Defaults to null.

Return value

A new StorageEvent object.

Specifications

This feature does not appear to be defined in any specification.

Browser compatibility

See also