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.

interface StorageEvent {
    AT_TARGET: number;
    BUBBLING_PHASE: number;
    CAPTURING_PHASE: number;
    NONE: number;
    bubbles: boolean;
    cancelBubble: boolean;
    cancelable: boolean;
    composed: boolean;
    currentTarget: EventTarget;
    defaultPrevented: boolean;
    eventPhase: number;
    isTrusted: boolean;
    key: string;
    newValue: string;
    oldValue: string;
    returnValue: boolean;
    srcElement: EventTarget;
    storageArea: Storage;
    target: EventTarget;
    timeStamp: number;
    type: string;
    url: string;
    composedPath(): EventTarget[];
    initEvent(type, bubbles?, cancelable?): void;
    initStorageEvent(type, bubbles?, cancelable?, key?, oldValue?, newValue?, url?, storageArea?): 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

Readonly AT_TARGET

AT_TARGET: number

Readonly BUBBLING_PHASE

BUBBLING_PHASE: number

Readonly CAPTURING_PHASE

CAPTURING_PHASE: number

Readonly NONE

NONE: number

Readonly bubbles

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.

cancelBubble

cancelBubble: boolean

Deprecated

Readonly cancelable

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.

Readonly composed

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.

Readonly currentTarget

currentTarget: EventTarget

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

Readonly defaultPrevented

defaultPrevented: boolean

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

Readonly eventPhase

eventPhase: number

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

Readonly isTrusted

isTrusted: boolean

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

Readonly key

key: string

Returns the key of the storage item being changed.

Readonly newValue

newValue: string

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

Readonly oldValue

oldValue: string

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

returnValue

returnValue: boolean

Deprecated

Readonly srcElement

srcElement: EventTarget

Deprecated

Readonly storageArea

storageArea: Storage

Returns the Storage object that was affected.

Readonly target

target: EventTarget

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

Readonly timeStamp

timeStamp: number

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

Readonly type

type: string

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

Readonly url

url: string

Returns the URL of the document whose storage item changed.

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.

    Returns EventTarget[]

initEvent

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

  • Parameters

    • type: string
    • Optional bubbles: boolean
    • Optional cancelable: boolean

    Returns void

    Deprecated

initStorageEvent

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

  • Parameters

    • type: string
    • Optional bubbles: boolean
    • Optional cancelable: boolean
    • Optional key: string
    • Optional oldValue: string
    • Optional newValue: string
    • Optional url: string | URL
    • Optional storageArea: Storage

    Returns void

    Deprecated

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.

    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.

    Returns void

stopPropagation

  • stopPropagation(): void

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

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc