DedicatedWorkerGlobalScope: message event

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{APIRef("Web Workers API")}}{{AvailableInWorkers("dedicated")}}

The message event is fired on a {{domxref('DedicatedWorkerGlobalScope')}} object when the worker receives a message from its parent (i.e., when the parent sends a message using [Worker.postMessage()](/en-US/docs/Web/API/Worker/postMessage)).

This event is not cancellable and does not bubble.

Syntax

Use the event name in {{domxref("EventTarget/addEventListener", "addEventListener()")}}:

js-nolint
addEventListener("message", (event) => { })

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

js-nolint
onmessage = (event) => { }

Event type

A {{domxref("MessageEvent")}}. Inherits from {{domxref("Event")}}.

{{InheritanceDiagram("MessageEvent")}}

Example

The following code snippet shows creation of a {{domxref("Worker")}} object using the {{domxref("Worker.Worker", "Worker()")}} constructor. Messages are passed to the worker when the value inside the form input first changes. An {{domxref("Worker.message_event", "onmessage")}} handler is also present, to deal with messages are passed back from the worker.

js
// main.js

const myWorker = new Worker("worker.js");

first.onchange = () => {
  myWorker.postMessage([first.value, second.value]);
  console.log("Message posted to worker");
};

myWorker.onmessage = (e) => {
  result.textContent = e.data;
  console.log("Message received from worker");
};

The worker assigns an onmessage handler to its global scope (but note that this replaces other event listeners added using onmessage, if any):

js
// worker.js

self.onmessage = (e) => {
  console.log("Message received from main script");
  const workerResult = `Result: ${e.data[0] * e.data[1]}`;
  console.log("Posting message back to main script");
  postMessage(workerResult);
};

Alternatively, the worker script can listen for the message using [addEventListener()](/en-US/docs/Web/API/EventTarget/addEventListener):

js
// worker.js

self.addEventListener("message", (e) => {
  console.log("Message received from main script");
  const workerResult = `Result: ${e.data[0] * e.data[1]}`;
  console.log("Posting message back to main script");
  postMessage(workerResult);
});

Notice how in the main script, onmessage has to be defined on myWorker, whereas inside the worker script you just need onmessage because the worker is effectively the global scope ({{domxref("DedicatedWorkerGlobalScope")}}).

For a full example, see our Basic dedicated worker example (run dedicated worker).

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • {{domxref("DedicatedWorkerGlobalScope")}}
  • {{domxref("WorkerGlobalScope")}}
  • Related events: [messageerror](/en-US/docs/Web/API/DedicatedWorkerGlobalScope/messageerror_event)
  • [Worker.postMessage()](/en-US/docs/Web/API/Worker/postMessage)
  • Using channel messaging