Web Workers API
Web Workers are a mechanism by which a script operation can be made to run in a background thread separate from the main execution thread of a web application. The advantage of this is that laborious processing can be performed in a separate thread, allowing the main (usually the UI) thread to run without being blocked/slowed down.
Web Workers concepts and usage
A worker is an object created using a
constructor (e.g. Worker()
) that runs a named JavaScript file — this file contains the code that will run in the worker thread; workers run in another global context that is different from the current window
. This context is represented by a DedicatedWorkerGlobalScope
object in the case of dedicated workers (standard workers that are utilized by a single script; shared workers use SharedWorkerGlobalScope
).
You can run whatever code you like inside the worker thread, with some exceptions. For example, you can't directly manipulate the DOM from inside a worker, or use some default methods and properties of the window
object. But you can use a large number of items available under window
, including WebSockets, and data storage mechanisms like IndexedDB and the Firefox OS-only Data Store API. See Functions and classes available to workers for more details.
Data is sent between workers and the main thread via a system of messages — both sides send their messages using the postMessage()
method, and respond to messages via the onmessage
event handler (the message is contained within the Message
event's data attribute.) The data is copied rather than shared.
Workers may in turn spawn new workers, as long as those workers are hosted within the same origin as the parent page. In addition, workers may use XMLHttpRequest
for network I/O, with the exception that the responseXML
and channel
attributes on XMLHttpRequest
always return null
.
In addition to dedicated workers, there are other types of worker:
- Shared workers are workers that can be utilized by multiple scripts running in different windows, IFrames, etc., as long as they are in the same domain as the worker. They are a little more complex than dedicated workers — scripts must communicate via an active port. See
SharedWorker
for more details. - ServiceWorkers essentially act as proxy servers that sit between web applications, and the browser and network (when available). They are intended to (amongst other things) enable the creation of effective offline experiences, intercepting network requests and taking appropriate action based on whether the network is available and updated assets reside on the server. They will also allow access to push notifications and background sync APIs.
- Chrome Workers are a Firefox-only type of worker that you can use if you are developing add-ons and want to use workers in extensions and have access to js-ctypes in your worker. See
ChromeWorker
for more details. - Audio Workers provide the ability for direct scripted audio processing to be done inside a web worker context.
Note: As per the Web workers Spec, worker error events should not bubble (see bug 1188141. This has been implemented in Firefox 42.
Web Worker interfaces
AbstractWorker
- Abstracts properties and methods common to all kind of workers (i.e.
Worker
orSharedWorker
). Worker
- Represents a running worker thread, allowing you to pass messages to the running worker code.
SharedWorker
- Represents a specific kind of worker that can be accessed from several browsing contexts, being several windows, iframes or even workers.
WorkerGlobalScope
- Represents the generic scope of any worker (doing the same job as
Window
does for normal web content). Different types of worker have scope objects that inherit from this interface and add more specific features. DedicatedWorkerGlobalScope
- Represents the scope of a dedicated worker, inheriting from
WorkerGlobalScope
and adding some dedicated features. SharedWorkerGlobalScope
- Represents the scope of a shared worker, inheriting from
WorkerGlobalScope
and adding some dedicated features. WorkerNavigator
- Represents the identity and state of the user agent (the client):
Examples
We have created a couple of simple demos to show basic usage:
- Basic dedicated worker example (run dedicated worker).
- Basic shared worker example (run shared worker).
You can find out more information on how these demos work in Using web workers.
Specifications
Specification | Status | Comment |
---|---|---|
WHATWG HTML Living Standard | Living Standard | No change from Web Workers. |
Web Workers | Candidate Recommendation | Initial definition. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | 4 | 3.5 (1.9.1) | 10.0 | 10.6 | 4 |
Shared workers | 4 | 29 (29) | Not supported | 10.6 | 4 |
Passing data using structured cloning | 13 | 8 (8) | 10.0 | 11.5 | 6 |
Passing data using transferable objects | 17 webkit 21 |
18 (18) | Not supported | 15 | 6 |
Global URL |
10[1] 23 |
21 (21) | 11 | 15 | 6[1] |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | Firefox OS (Gecko) | IE Phone | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|---|
Basic support | 4.4 | 4 | 1.0 (1.9.1) | 1.0.1 | 10.0 | 11.5 | 5.1 |
Shared workers | Not supported | 4 | 29 | 1.4 | Not supported | Not supported | Not supported |
Passing data using structured cloning | Not supported | 4 | 8 | 1.0.1 | Not supported | Not supported | Not supported |
Passing data using transferable objects | Not supported | Not supported | 18 | 1.0.1 | Not supported | Not supported | Not supported |
[1] As webkitURL
.
See also
- Using Web Workers
- Worker Interface
- SharedWorker interface
- ServiceWorker API
- Functions and classes available to workers
- Advanced concepts and examples
- ChromeWorker: for using workers in privileged/chrome code
License
© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/web_workers_api