Service Workers APIservice
The ExtendableMessageEvent interface of the Service Worker API represents the event object of a ServiceWorkerGlobalScope/message_event event fired on a service worker (when a message is received on the ServiceWorkerGlobalScope from another context) — extends the lifetime of such events.
This interface inherits from the ExtendableEvent interface.
Constructor
- ExtendableMessageEvent.ExtendableMessageEvent
- : Creates a new
ExtendableMessageEventobject instance.
- : Creates a new
Instance properties
Inherits properties from its parent, ExtendableEvent.
- ExtendableMessageEvent.data
- : Returns the event's data. It can be any data type. If dispatched in
messageerrorevent, the property will benull.
- : Returns the event's data. It can be any data type. If dispatched in
- ExtendableMessageEvent.origin
- : Returns the origin of the Client that sent the message.
- ExtendableMessageEvent.lastEventId
- : Represents, in server-sent events, the last event ID of the event source.
- ExtendableMessageEvent.source
- : Returns a reference to the Client object that sent the message.
- ExtendableMessageEvent.ports
- : Returns the array containing the MessagePort objects representing the ports of the associated message channel.
Instance methods
Inherits methods from its parent, ExtendableEvent.
Examples
In the below example a page gets a handle to the ServiceWorker object via ServiceWorkerRegistration.active, and then calls its postMessage() function.
// in the page being controlled
if (navigator.serviceWorker) {
navigator.serviceWorker.register("service-worker.js");
navigator.serviceWorker.addEventListener("message", (event) => {
// event is a MessageEvent object
console.log(`The service worker sent me a message: ${event.data}`);
});
navigator.serviceWorker.ready.then((registration) => {
registration.active.postMessage("Hi service worker");
});
}
The service worker can receive the message by listening to the message event:
// in the service worker
addEventListener("message", (event) => {
// event is an ExtendableMessageEvent object
console.log(`The client sent me a message: ${event.data}`);
event.source.postMessage("Hi client");
});
Specifications
Browser compatibility
See also
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
