ServiceWorkerMessageEvent

Deprecated
This feature has been removed from the Web standards. Though some browsers may still support it, it is in the process of being dropped. Avoid using it and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Important: In modern browsers, this interface has been deprecated. Service worker messages will now use the MessageEvent interface, for consistency with other web messaging features.

The ServiceWorkerMessageEvent interface of the ServiceWorker API contains information about an event sent to a ServiceWorkerContainer target. This extends the default message event to allow setting a ServiceWorker object as the source of a message. The event object is accessed via the handler function of a message event, when fired by a message received from a service worker.

This interface inherits from the Event interface.

Constructor

ServiceWorkerMessageEvent.ServiceWorkerMessageEvent()
Creates a new ServiceWorkerMessageEvent object instance.

Properties

Inherits properties from its parent, Event.

ServiceWorkerMessageEvent.data Read only
Returns the event's data. It can be any data type.
ServiceWorkerMessageEvent.origin Read only
Returns the origin of the service worker's environment settings object.
ServiceWorkerMessageEvent.lastEventId Read only
Represents, in server-sent events, the last event ID of the event source.
ServiceWorkerMessageEvent.source Read only
Returns a reference to the service worker that sent the message.
ServiceWorkerMessageEvent.ports Read only
Returns an array of MessagePort objects.

Methods

Inherits methods from its parent, Event.

Examples

When the following code is used inside the main thread to set up a message channel between it and a service worker for sending messages between the two, the event object of onmessage will be a ServiceWorkerMessageEvent.

navigator.serviceWorker.ready.then(function(reg) {  

  ...

      // set up a message channel to communicate with the SW
      var channel = new MessageChannel();
      channel.port1.onmessage = function(e) {
        console.log(e);
        handleChannelMessage(e.data);
      }
      
      mySW = reg.active;
      mySW.postMessage('hello', [channel.port2]);
  });

Specifications

Specification Status Comment
Service Workers
The definition of 'ServiceWorkerMessageEvent' in that specification.
Working Draft Initial definition.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support45

161

17

44 — 552 3 No24 No
ServiceWorkerMessageEvent constructor45

161

17

44 — 552 3 No24 No
data45

161

17

44 — 552 3 No24 No
origin45

161

17

44 — 552 3 No24 No
lastEventId45

161

17

44 — 552 3 No24 No
source45

161

17

44 — 552 3 No24 No
ports45

161

17

44 — 552 3 No24 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No45 ?44 — 5524 No4.0
ServiceWorkerMessageEvent constructor No45 ?44 — 5524 No4.0
data No45 ?44 — 5524 No4.0
origin No45 ?44 — 5524 No4.0
lastEventId No45 ?44 — 5524 No4.0
source No45 ?44 — 5524 No4.0
ports No45 ?44 — 5524 No4.0

1. From version 16: this feature is behind the Enable service workers preference.

2. Service workers (and Push) have been disabled in the Firefox 45 and 52 Extended Support Releases (ESR).

3. In Firefox 55 and later, the standard MessageEvent interface must be used instead.

See also

Document Tags and Contributors

 Contributors to this page: fscholz, abbycar, chrisdavidmills, narohcp, jpmedley
 Last updated by: fscholz,