Interface MessageEvent<T>

    An event which takes place in the DOM.

    MDN Reference

    interface MessageEvent<T = any> {
        AT_TARGET: 2;
        bubbles: boolean;
        BUBBLING_PHASE: 3;
        cancelable: boolean;
        cancelBubble: boolean;
        CAPTURING_PHASE: 1;
        composed: boolean;
        currentTarget: EventTarget;
        data: T;
        defaultPrevented: boolean;
        eventPhase: number;
        isTrusted: boolean;
        lastEventId: string;
        NONE: 0;
        origin: string;
        ports: readonly MessagePort[];
        returnValue: boolean;
        source: MessageEventSource;
        srcElement: EventTarget;
        target: EventTarget;
        timeStamp: number;
        type: string;
        composedPath(): EventTarget[];
        initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
        initMessageEvent(
            type: string,
            bubbles?: boolean,
            cancelable?: boolean,
            data?: any,
            origin?: string,
            lastEventId?: string,
            source?: MessageEventSource,
            ports?: MessagePort[],
        ): void;
        initMessageEvent(
            type: string,
            bubbles?: boolean,
            cancelable?: boolean,
            data?: any,
            origin?: string,
            lastEventId?: string,
            source?: MessageEventSource,
            ports?: Iterable<MessagePort>,
        ): void;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
    }

    Type Parameters

    • T = any
    Hierarchy

    Properties

    AT_TARGET bubbles BUBBLING_PHASE cancelable cancelBubble CAPTURING_PHASE composed currentTarget data defaultPrevented eventPhase isTrusted lastEventId NONE origin ports returnValue source srcElement target timeStamp type

    Methods

    composedPath initEvent initMessageEvent preventDefault stopImmediatePropagation stopPropagation

    Properties

    ReadonlyAT_TARGET

    AT_TARGET: 2

    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

    ReadonlyBUBBLING_PHASE

    BUBBLING_PHASE: 3

    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

    cancelBubble

    cancelBubble: boolean

    Deprecated

    MDN Reference

    ReadonlyCAPTURING_PHASE

    CAPTURING_PHASE: 1

    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: EventTarget

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

    MDN Reference

    Readonlydata

    data: T

    Returns the data of the message.

    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

    ReadonlylastEventId

    lastEventId: string

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

    MDN Reference

    ReadonlyNONE

    NONE: 0

    Readonlyorigin

    origin: string

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

    MDN Reference

    Readonlyports

    ports: readonly MessagePort[]

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

    MDN Reference

    returnValue

    returnValue: boolean

    Deprecated

    MDN Reference

    Readonlysource

    source: MessageEventSource

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

    MDN Reference

    ReadonlysrcElement

    srcElement: EventTarget

    Deprecated

    MDN Reference

    Readonlytarget

    target: 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

    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: string, bubbles?: boolean, cancelable?: boolean): void

    • Parameters

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

      Returns void

      Deprecated

      MDN Reference

    initMessageEvent

    • initMessageEvent(
          type: string,
          bubbles?: boolean,
          cancelable?: boolean,
          data?: any,
          origin?: string,
          lastEventId?: string,
          source?: MessageEventSource,
          ports?: MessagePort[],
      ): void

    • Parameters

      • type: string
      • Optionalbubbles: boolean
      • Optionalcancelable: boolean
      • Optionaldata: any
      • Optionalorigin: string
      • OptionallastEventId: string
      • Optionalsource: MessageEventSource
      • Optionalports: MessagePort[]

      Returns void

      Deprecated

    • initMessageEvent(
          type: string,
          bubbles?: boolean,
          cancelable?: boolean,
          data?: any,
          origin?: string,
          lastEventId?: string,
          source?: MessageEventSource,
          ports?: Iterable<MessagePort>,
      ): void

    • Parameters

      • type: string
      • Optionalbubbles: boolean
      • Optionalcancelable: boolean
      • Optionaldata: any
      • Optionalorigin: string
      • OptionallastEventId: string
      • Optionalsource: MessageEventSource
      • Optionalports: Iterable<MessagePort>

      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.

      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