BroadcastChannel: messageerror event

Baseline 2022

Newly available

Since March 2022, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

The messageerror event is fired on a BroadcastChannel object when a message that can't be deserialized arrives on the channel.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("messageerror", (event) => { })
onmessageerror = (event) => { }

Event type

Event properties

In addition to the properties listed below, properties from the parent interface, Event, are available.

data Read only

The data sent by the message emitter.

origin Read only

A string representing the origin of the message emitter.

lastEventId Read only

A string representing a unique ID for the event.

source Read only

A message event source, which is either a WindowProxy, a MessagePort, or a ServiceWorker object representing the message emitter.

ports Read only

An array of MessagePort objects representing the ports associated with the channel the message is being sent through (where appropriate, e.g. in channel messaging or when sending a message to a shared worker).

Examples

This code uses addEventListener to listen for messages and errors:

js
const channel = new BroadcastChannel("example-channel");

channel.addEventListener("message", (event) => {
  received.textContent = event.data;
});

channel.addEventListener("messageerror", (event) => {
  console.error(event);
});

The same, but using the onmessage and onmessageerror event handler properties:

js
const channel = new BroadcastChannel("example-channel");

channel.onmessage = (event) => {
  received.textContent = event.data;
};

channel.onmessageerror = (event) => {
  console.log(event);
};

Specifications

Specification
HTML Standard
# event-messageerror
HTML Standard
# handler-broadcastchannel-onmessageerror

Browser compatibility

BCD tables only load in the browser

See also