StorageEvent

A StorageEvent is sent to a window when a storage area it has access to is changed within the context of another document.

  <div id="interfaceDiagram" style="display: inline-block; position: relative; width: 100%; padding-bottom: 11.666666666666666%; vertical-align: middle; overflow: hidden;"><svg style="display: inline-block; position: absolute; top: 0; left: 0;" viewbox="-50 0 600 70" preserveAspectRatio="xMinYMin meet"><a xlink:href="/docs/Web/API/Event" target="_top"><rect x="1" y="1" width="75" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text  x="38.5" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">Event</text></a><polyline points="76,25  86,20  86,30  76,25" stroke="#D4DDE4" fill="none"/><line x1="86" y1="25" x2="116" y2="25" stroke="#D4DDE4"/><a xlink:href="/docs/Web/API/StorageEvent" target="_top"><rect x="116" y="1" width="120" height="50" fill="#F4F7F8" stroke="#D4DDE4" stroke-width="2px" /><text  x="176" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">StorageEvent</text></a></svg></div>

  a:hover text { fill: #0095DD; pointer-events: all;}

Method overview

void initStorageEvent(
  in DOMString type,
  in boolean canBubble,
  in boolean cancelable,
  in DOMString key,
  in DOMString oldValue,
  in DOMString newValue,
  in USVString url,
  in Storage storageArea
);

Attributes

Methods

initStorageEvent()

Initializes the event in a manner analogous to the similarly-named initEvent() method in the DOM Events interfaces.

Syntax

storageEvent.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.

Specifications

Browser compatibility