Skip to main content

MessageEvent

The MessageEvent interface represents a message received by a target object.

MDN Reference

Extends​

Type Parameters​

Type ParameterDefault type
Tany

Methods​

composedPath()​

composedPath(): EventTarget[];

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[]

Inherited from​

Event.composedPath

initEvent()​

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

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

Parameters​

ParameterType
typestring
bubbles?boolean
cancelable?boolean

Returns​

void

Deprecated​

MDN Reference

Inherited from​

Event.initEvent

initMessageEvent()​

Call Signature​

initMessageEvent(
   type, 
   bubbles?, 
   cancelable?, 
   data?, 
   origin?, 
   lastEventId?, 
   source?, 
   ports?
): void;
Parameters​
ParameterType
typestring
bubbles?boolean
cancelable?boolean
data?any
origin?string
lastEventId?string
source?MessageEventSource | null
ports?MessagePort[]
Returns​

void

Deprecated​

Call Signature​

initMessageEvent(
   type, 
   bubbles?, 
   cancelable?, 
   data?, 
   origin?, 
   lastEventId?, 
   source?, 
   ports?
): void;
Parameters​
ParameterType
typestring
bubbles?boolean
cancelable?boolean
data?any
origin?string
lastEventId?string
source?MessageEventSource | null
ports?Iterable<MessagePort, any, any>
Returns​

void

Deprecated​

preventDefault()​

preventDefault(): void;

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

Inherited from​

Event.preventDefault

stopImmediatePropagation()​

stopImmediatePropagation(): void;

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

MDN Reference

Returns​

void

Inherited from​

Event.stopImmediatePropagation

stopPropagation()​

stopPropagation(): 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

Inherited from​

Event.stopPropagation

Properties​

AT_TARGET​

readonly AT_TARGET: 2;

Inherited from​

Event.AT_TARGET

bubbles​

readonly 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

Inherited from​

Event.bubbles

BUBBLING_PHASE​

readonly BUBBLING_PHASE: 3;

Inherited from​

Event.BUBBLING_PHASE

cancelable​

readonly 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

Inherited from​

Event.cancelable

cancelBubble​

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.

Deprecated​

MDN Reference

Inherited from​

Event.cancelBubble

CAPTURING_PHASE​

readonly CAPTURING_PHASE: 1;

Inherited from​

Event.CAPTURING_PHASE

composed​

readonly 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

Inherited from​

Event.composed

currentTarget​

readonly 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

Inherited from​

Event.currentTarget

data​

readonly data: T;

The data read-only property of the MessageEvent interface represents the data sent by the message emitter.

MDN Reference

defaultPrevented​

readonly 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

Inherited from​

Event.defaultPrevented

eventPhase​

readonly eventPhase: number;

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

MDN Reference

Inherited from​

Event.eventPhase

isTrusted​

readonly 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

Inherited from​

Event.isTrusted

lastEventId​

readonly lastEventId: string;

The lastEventId read-only property of the MessageEvent interface is a string representing a unique ID for the event.

MDN Reference

NONE​

readonly NONE: 0;

Inherited from​

Event.NONE

origin​

readonly origin: string;

The origin read-only property of the MessageEvent interface is a string representing the origin of the message emitter.

MDN Reference

ports​

readonly ports: readonly MessagePort[];

The ports read-only property of the MessageEvent interface is an array of MessagePort objects containing all MessagePort objects sent with the message, in order.

MDN Reference

returnValue​

returnValue: boolean;

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

Deprecated​

MDN Reference

Inherited from​

Event.returnValue

source​

readonly source: MessageEventSource | null;

The source read-only property of the MessageEvent interface is a MessageEventSource (which can be a WindowProxy, MessagePort, or ServiceWorker object) representing the message emitter.

MDN Reference

srcElement​

readonly srcElement: EventTarget | null;

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

Deprecated​

MDN Reference

Inherited from​

Event.srcElement

target​

readonly 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

Inherited from​

Event.target

timeStamp​

readonly timeStamp: number;

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

MDN Reference

Inherited from​

Event.timeStamp

type​

readonly 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

Inherited from​

Event.type