Join us online - 19th of November
Save your spot

Interface StorageEvent

The StorageEvent interface is implemented by the storage event, which is sent to a window when a storage area the window has access to is changed within the context of another document.

MDN Reference

interface StorageEvent {
    AT_TARGET: 2;
    bubbles: boolean;
    BUBBLING_PHASE: 3;
    cancelable: boolean;
    cancelBubble: boolean;
    CAPTURING_PHASE: 1;
    composed: boolean;
    currentTarget: EventTarget | null;
    defaultPrevented: boolean;
    eventPhase: number;
    isTrusted: boolean;
    key: string | null;
    newValue: string | null;
    NONE: 0;
    oldValue: string | null;
    returnValue: boolean;
    srcElement: EventTarget | null;
    storageArea: Storage | null;
    target: EventTarget | null;
    timeStamp: number;
    type: string;
    url: string;
    composedPath(): EventTarget[];
    initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
    initStorageEvent(
        type: string,
        bubbles?: boolean,
        cancelable?: boolean,
        key?: string | null,
        oldValue?: string | null,
        newValue?: string | null,
        url?: string | URL,
        storageArea?: Storage | null,
    ): void;
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}

Hierarchy

  • Event
    • StorageEvent
Index
AT_TARGET bubbles BUBBLING_PHASE cancelable cancelBubble CAPTURING_PHASE composed currentTarget defaultPrevented eventPhase isTrusted key newValue NONE oldValue returnValue srcElement storageArea target timeStamp type url
composedPath initEvent initStorageEvent preventDefault stopImmediatePropagation stopPropagation
AT_TARGET: 2
bubbles: boolean

The bubbles read-only property of the Event interface indicates whether the event bubbles up through the DOM tree or not.

MDN Reference

BUBBLING_PHASE: 3
cancelable: boolean

The cancelable read-only property of the Event interface indicates whether the event can be canceled, and therefore prevented as if the event never happened.

MDN Reference

cancelBubble: boolean

The cancelBubble property of the Event interface is deprecated. Use Event.stopPropagation() instead. Setting its value to true before returning from an event handler prevents propagation of the event. In later implementations, setting this to false does nothing. See Browser compatibility for details.

MDN Reference

CAPTURING_PHASE: 1
composed: boolean

The read-only composed property of the Event interface returns a boolean value which indicates whether or not the event will propagate across the shadow DOM boundary into the standard DOM.

MDN Reference

currentTarget: EventTarget | null

The currentTarget read-only property of the Event interface identifies the element to which the event handler has been attached.

MDN Reference

defaultPrevented: boolean

The defaultPrevented read-only property of the Event interface returns a boolean value indicating whether or not the call to Event.preventDefault() canceled the event.

MDN Reference

eventPhase: number

The eventPhase read-only property of the Event interface indicates which phase of the event flow is currently being evaluated.

MDN Reference

isTrusted: boolean

The isTrusted read-only property of the Event interface is a boolean value that is true when the event was generated by the user agent (including via user actions and programmatic methods such as HTMLElement.focus()), and false when the event was dispatched via EventTarget.dispatchEvent(). The only exception is the click event, which initializes the isTrusted property to false in user agents.

MDN Reference

key: string | null

The key property of the StorageEvent interface returns the key for the storage item that was changed.

MDN Reference

newValue: string | null

The newValue property of the StorageEvent interface returns the new value of the storage item whose value was changed.

MDN Reference

NONE: 0
oldValue: string | null

The oldValue property of the StorageEvent interface returns the original value of the storage item whose value changed.

MDN Reference

returnValue: boolean

The Event property returnValue indicates whether the default action for this event has been prevented or not.

MDN Reference

srcElement: EventTarget | null

The deprecated Event.srcElement is an alias for the Event.target property. Use Event.target instead.

MDN Reference

storageArea: Storage | null

The storageArea property of the StorageEvent interface returns the storage object that was affected.

MDN Reference

target: EventTarget | null

The read-only target property of the Event interface is a reference to the object onto which the event was dispatched. It is different from Event.currentTarget when the event handler is called during the bubbling or capturing phase of the event.

MDN Reference

timeStamp: number

The timeStamp read-only property of the Event interface returns the time (in milliseconds) at which the event was created.

MDN Reference

type: string

The type read-only property of the Event interface returns a string containing the event's type. It is set when the event is constructed and is the name commonly used to refer to the specific event, such as click, load, or error.

MDN Reference

url: string

The url property of the StorageEvent interface returns the URL of the document whose storage changed.

MDN Reference

  • The composedPath() method of the Event interface returns the event's path which is an array of the objects on which listeners will be invoked. This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.

    MDN Reference

    Returns EventTarget[]

  • The Event.initEvent() method is used to initialize the value of an event created using Document.createEvent().

    Parameters

    • type: string
    • Optionalbubbles: boolean
    • Optionalcancelable: boolean

    Returns void

    MDN Reference

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

    Parameters

    • type: string
    • Optionalbubbles: boolean
    • Optionalcancelable: boolean
    • Optionalkey: string | null
    • OptionaloldValue: string | null
    • OptionalnewValue: string | null
    • Optionalurl: string | URL
    • OptionalstorageArea: Storage | null

    Returns void

    MDN Reference

  • The preventDefault() method of the Event interface tells the user agent that the event is being explicitly handled, so its default action, such as page scrolling, link navigation, or pasting text, should not be taken.

    MDN Reference

    Returns void

  • The stopImmediatePropagation() method of the Event interface prevents other listeners of the same event from being called.

    MDN Reference

    Returns void

  • The stopPropagation() method of the Event interface prevents further propagation of the current event in the capturing and bubbling phases. It does not, however, prevent any default behaviors from occurring; for instance, clicks on links are still processed. If you want to stop those behaviors, see the preventDefault() method. It also does not prevent propagation to other event-handlers of the current element. If you want to stop those, see stopImmediatePropagation().

    MDN Reference

    Returns void

Was this helpful?