Bun.MessageEvent TypeScript type alias | API Reference | Bun

Helper type for avoiding conflicts in types.

Uses the lib.dom.d.ts definition if it exists, otherwise defines it locally.

This is to avoid type conflicts between lib.dom.d.ts and @types/bun.

Unfortunately some symbols cannot be defined when both Bun types and lib.dom.d.ts types are loaded, and since we can't redeclare the symbol in a way that satisfies both, we need to fallback to the type that lib.dom.d.ts provides.

A message received by a target object.

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

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

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

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

MDN Reference

Returns the data of the message.

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

MDN Reference

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

MDN Reference

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

MDN Reference

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

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

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

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

MDN Reference

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

MDN Reference

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

MDN Reference

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 an array containing the current EventTarget as the only entry or empty if the event is not being dispatched. This is not used in Node.js and is provided purely for completeness.

Sets the defaultPrevented property to true if cancelable is true.

Stops the invocation of event listeners after the current one completes.

This is not used in Node.js and is provided purely for completeness.