MDN self-hosted library · e01.org

ServiceWorkerContainer: message event

Service Workers API

Service Workers API

The message event is used in a page controlled by a service worker to receive messages from the service worker.

This event is not cancelable and does not bubble.

Syntax

Use the event name in addEventListener():

addEventListener("message", (event) => { })

Alternatively, assign to the event handler property of the interface:

onmessage = (event) => { }

Event type

A MessageEvent. Inherits from Event.

MessageEvent

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 clients.get(clientId);
  client.postMessage("Hi client!");
}

addEventListener("fetch", (event) => {
  messageClient(event.clientId);
  event.respondWith(() => {
    // …
  });
});

The client can receive the message by listening to the message event:

// main.js
navigator.serviceWorker.addEventListener("message", (message) => {
  console.log(message);
});

Alternatively, the client can receive the message with the onmessage event handler (but note that this replaces other event listeners added using onmessage, if any):

// main.js
navigator.serviceWorker.onmessage = (message) => {
  console.log(message);
};

Specifications

Browser compatibility

See also