ServiceWorkerContainer: messageerror event
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2023.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Web Workers.
The messageerror event is fired to the ServiceWorkerContainer when an incoming message sent to the associated worker can't be deserialized.
This event is not cancelable and does not bubble.
Syntax
Use the event name in methods like addEventListener(), or set an event handler property.
addEventListener("messageerror", (event) => { })
onmessageerror = (event) => { }
Event type
A MessageEvent. Inherits from Event.
Event properties
This interface also inherits properties from its parent, Event.
MessageEvent.dataRead only-
The data sent by the message emitter.
MessageEvent.originRead only-
A string representing the origin of the message emitter.
MessageEvent.lastEventIdRead only-
A string representing a unique ID for the event.
MessageEvent.sourceRead only-
A
MessageEventSource(which can be a WindowProxy,MessagePort, orServiceWorkerobject) representing the message emitter. MessageEvent.portsRead only-
An array of
MessagePortobjects 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
In this example the service worker get the client's ID from a fetch event and then sends it a message using Client.postMessage:
// service-worker.js
async function messageClient(clientId) {
const client = await self.clients.get(clientId);
client.postMessage("Hi client!");
}
self.addEventListener("fetch", (event) => {
messageClient(event.clientId);
event.respondWith(() => {
// …
});
});
The service worker can listen for the message deserialization error by listening to the messageerror event:
// main.js
navigator.serviceWorker.addEventListener("messageerror", (event) => {
console.error("Receive message from service worker failed!");
});
Alternatively, the script can listen for the message deserialization error using onmessageerror:
// main.js
navigator.serviceWorker.onmessageerror = (event) => {
console.error("Receive message from service worker failed!");
};
Specifications
| Specification |
|---|
| Service Workers> # dom-serviceworkerglobalscope-onmessageerror> |
Browser compatibility
Loading…