Worker: message event
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Note: This feature is available in Web Workers, except for Service Workers.
The message event is fired on a Worker object when the worker's parent receives a message from its worker (i.e., when the worker sends a message using DedicatedWorkerGlobalScope.postMessage()).
This event is not cancellable and does not bubble.
Syntax
Use the event name in methods like addEventListener(), or set an event handler property.
addEventListener("message", (event) => { })
onmessage = (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
This code creates a new worker and listens to messages from it using addEventListener():
const worker = new Worker("static/scripts/worker.js");
worker.addEventListener("message", (event) => {
console.log(`Received message from worker: ${event.data}`);
});
Alternatively, it could listen using the onmessage event handler property:
const worker = new Worker("static/scripts/worker.js");
worker.onmessage = (event) => {
console.log(`Received message from worker: ${event.data}`);
};
The worker posts messages using self.postMessage():
// static/scripts/worker.js
self.postMessage("I'm alive!");
Specifications
| Specification |
|---|
| HTML> # event-message> |
Browser compatibility
Loading…
See also
- Related events:
messageerror. DedicatedWorkerGlobalScope.postMessage().