Worker

The Worker interface of the Web Workers API represents a background task that can be easily created and can send messages back to its creator. Creating a worker is as simple as calling the Worker() constructor and specifying a script to be run in the worker thread.

Workers may in turn spawn new workers as long as those workers are hosted within the same origin as the parent page (Note: nested workers are currently not implemented in WebKit). In addition workers may use XMLHttpRequest for network I/O, with the stipulation that the responseXML and channel attributes on XMLHttpRequest always return null.

Not all interfaces and functions are available to the script associated with a Worker.

In Firefox, if you want to use workers in extensions and would like to have access to js-ctypes, you should use the ChromeWorker object instead.

Constructors

Worker()

Creates a dedicated web worker that executes the script at the specified URL. Workers can also be constructed using Blobs.

Properties

Inherits properties from its parent, EventTarget, and implements properties from AbstractWorker.

Event handlers

AbstractWorker.onerror

An EventListener called whenever an ErrorEvent of type error bubbles through to the worker. This is inherited from AbstractWorker.

Worker.onmessage

An EventListener called whenever a MessageEvent of type message bubbles through the worker — i.e. when a message is sent to the parent document from the worker via DedicatedWorkerGlobalScope.postMessage. The message is stored in the event's data property.

Worker.onmessageerror

Is an EventHandler representing the code to be called when the messageerror event is raised.

Methods

Inherits methods from its parent, EventTarget, and implements methods from AbstractWorker.

Worker.postMessage()

Sends a message — which can consist of any JavaScript object — to the worker's inner scope.

Worker.terminate()

Immediately terminates the worker. This does not offer the worker an opportunity to finish its operations; it is simply stopped at once. ServiceWorker instances do not support this method.

Example

The following code snippet shows creation of a Worker object using the Worker() constructor and usage of the object:

var myWorker = new Worker('worker.js');
var first = document.querySelector('#number1');
var second = document.querySelector('#number2');

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

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

Specifications

Browser compatibilityUpdate compatibility data on GitHub

Support varies for different types of workers. See each worker type's page for specifics.

Cross-origin worker error behaviour

In earlier browser versions, trying to load a cross-origin worker script threw a SecurityError; in newer browsers an error event is thrown instead due to a spec change. Find out more information on how to deal with this in Loading cross-origin worker now fires error event instead of throwing; worker in sandboxed iframe no longer allowed.

See also

• Using web workers
• Functions available to workers
• Other kind of workers: SharedWorker and ServiceWorker.
• Non-standard, Gecko-specific workers: ChromeWorker, used by extensions.