Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MessageEvent

Package version

A message received by a target object.

Hierarchy

Index

Properties

AT_TARGET

AT_TARGET: number

BUBBLING_PHASE

BUBBLING_PHASE: number

CAPTURING_PHASE

CAPTURING_PHASE: number

Event

Event: { constructor: any; AT_TARGET: number; BUBBLING_PHASE: number; CAPTURING_PHASE: number; NONE: number; prototype: Event }

Type declaration

  • constructor: function
    • Parameters

      • type: string
      • Optional eventInitDict: EventInit

      Returns Event

  • AT_TARGET: number
  • BUBBLING_PHASE: number
  • CAPTURING_PHASE: number
  • NONE: number
  • prototype: Event

NONE

NONE: number

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

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.

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.

currentTarget

currentTarget: EventTarget | null

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

data

data: any

Returns the data of the message.

defaultPrevented

defaultPrevented: boolean

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

eventPhase

eventPhase: number

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

isTrusted

isTrusted: boolean

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

lastEventId

lastEventId: string

Returns the last event ID string, for server-sent events.

origin

origin: string

Returns the origin of the message, for server-sent events and cross-document messaging.

ports

Returns the MessagePort array sent with the message, for cross-document messaging and channel messaging.

returnValue

returnValue: boolean

source

source: MessageEventSource | null

Returns the WindowProxy of the source window, for cross-document messaging, and the MessagePort being attached, in the connect event fired at SharedWorkerGlobalScope objects.

srcElement

srcElement: EventTarget | null
deprecated

target

target: EventTarget | null

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

timeStamp

timeStamp: number

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

type

type: string

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

Methods

composedPath

  • 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: string, bubbles?: undefined | false | true, cancelable?: undefined | false | true): void
  • Parameters

    • type: string
    • Optional bubbles: undefined | false | true
    • Optional cancelable: undefined | false | true

    Returns void

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

Generated using TypeDoc