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 insecure contexts (HTTPS), in some or allsupporting browsers.
Note: This feature is available inWeb Workers.
Themessageerror
event is fired to theServiceWorkerContainer
when an incoming message sent to the associated worker can't be deserialized.
This event is not cancelable and does not bubble.
In this article
Syntax
Use the event name in methods likeaddEventListener()
, or set an event handler property.
addEventListener("messageerror", (event) => { })onmessageerror = (event) => { }
Event type
AMessageEvent
. Inherits fromEvent
.
Event properties
This interface also inherits properties from its parent,Event
.
MessageEvent.data
Read onlyThe data sent by the message emitter.
MessageEvent.origin
Read onlyA string representing the origin of the message emitter.
MessageEvent.lastEventId
Read onlyA string representing a unique ID for the event.
MessageEvent.source
Read onlyA
MessageEventSource
(which can be aWindowProxy,MessagePort
, orServiceWorker
object) representing the message emitter.MessageEvent.ports
Read onlyAn 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
In this example the service worker get the client's ID from afetch
event and then sends it a message usingClient.postMessage
:
// service-worker.jsasync 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 themessageerror
event:
// main.jsnavigator.serviceWorker.addEventListener("messageerror", (event) => { console.error("Receive message from service worker failed!");});
Alternatively, the script can listen for the message deserialization error usingonmessageerror
:
// main.jsnavigator.serviceWorker.onmessageerror = (event) => { console.error("Receive message from service worker failed!");};
Specifications
Specification |
---|
Service Workers> # dom-serviceworkerglobalscope-onmessageerror> |
Browser compatibility
Loading…