Interface StorageEvent

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

MDN Reference

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

Hierarchy

  • Event
    • StorageEvent

Properties

AT_TARGET BUBBLING_PHASE CAPTURING_PHASE NONE bubbles cancelBubble cancelable composed currentTarget defaultPrevented eventPhase isTrusted key newValue oldValue returnValue srcElement storageArea target timeStamp type url

Methods

composedPath initEvent initStorageEvent preventDefault stopImmediatePropagation stopPropagation

Properties

ReadonlyAT_TARGET

AT_TARGET: 2

ReadonlyBUBBLING_PHASE

BUBBLING_PHASE: 3

ReadonlyCAPTURING_PHASE

CAPTURING_PHASE: 1

ReadonlyNONE

NONE: 0

Readonlybubbles

bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

MDN Reference

cancelBubble

cancelBubble: boolean

Deprecated

MDN Reference

Readonlycancelable

cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

MDN Reference

Readonlycomposed

composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

MDN Reference

ReadonlycurrentTarget

currentTarget: null | EventTarget

Returns the object whose event listener's callback is currently being invoked.

MDN Reference

ReadonlydefaultPrevented

defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

MDN Reference

ReadonlyeventPhase

eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

MDN Reference

ReadonlyisTrusted

isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

MDN Reference

Readonlykey

key: null | string

Returns the key of the storage item being changed.

MDN Reference

ReadonlynewValue

newValue: null | string

Returns the new value of the key of the storage item whose value is being changed.

MDN Reference

ReadonlyoldValue

oldValue: null | string

Returns the old value of the key of the storage item whose value is being changed.

MDN Reference

returnValue

returnValue: boolean

Deprecated

MDN Reference

ReadonlysrcElement

srcElement: null | EventTarget

Deprecated

MDN Reference

ReadonlystorageArea

storageArea: null | Storage

Returns the Storage object that was affected.

MDN Reference

Readonlytarget

target: null | EventTarget

Returns the object to which event is dispatched (its target).

MDN Reference

ReadonlytimeStamp

timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

MDN Reference

Readonlytype

type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

MDN Reference

Readonlyurl

url: string

Returns the URL of the document whose storage item changed.

MDN Reference

Methods

composedPath

  • composedPath(): EventTarget[]

  • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

    MDN Reference

    Returns EventTarget[]

initEvent

  • initEvent(type, bubbles?, cancelable?): void

  • Parameters

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

    Returns void

    Deprecated

    MDN Reference

initStorageEvent

  • initStorageEvent(type, bubbles?, cancelable?, key?, oldValue?, newValue?, url?, storageArea?): void

  • Parameters

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

    Returns void

    Deprecated

    MDN Reference

preventDefault

  • preventDefault(): void

  • If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

    MDN Reference

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void

  • Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

    MDN Reference

    Returns void

stopPropagation

  • stopPropagation(): void

  • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

    MDN Reference

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods