StorageEvent: initStorageEvent() method

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The StorageEvent.initStorageEvent() method is used to initialize the value of a StorageEvent.

Syntax

js

initStorageEvent(type)
initStorageEvent(type, canBubble)
initStorageEvent(type, canBubble, cancelable)
initStorageEvent(type, canBubble, cancelable, key)
initStorageEvent(type, canBubble, cancelable, key, oldValue)
initStorageEvent(type, canBubble, cancelable, key, oldValue, newValue)
initStorageEvent(type, canBubble, cancelable, key, oldValue, newValue, url)
initStorageEvent(type, canBubble, cancelable, key, oldValue, newValue, url, storageArea)

Parameters

typeArg

The name of the event.

canBubble Optional

A boolean indicating whether the event bubbles up through the DOM or not.

cancelable Optional

A boolean indicating whether the event is cancelable.

key Optional

The key whose value is changing as a result of this event.

oldValue Optional

The key's old value.

newValue Optional

The key's new value.

url Optional

The URL of the document initiating the change.

storageArea Optional

The Storage object representing the storage area on which this event occurred.

Return value

None (undefined).

Specifications

Specification
HTML Standard
# dom-storageevent-initstorageevent

Browser compatibility

BCD tables only load in the browser

See also

  • The constructor to use instead of this deprecated method: StorageEvent().