WorkerGlobalScope

The WorkerGlobalScope interface of the Web Workers API is an interface representing the scope of any worker. Workers have no browsing context; this scope contains the information usually conveyed by Window objects — in this case event handlers, the console or the associated WorkerNavigator object. Each WorkerGlobalScope has its own event loop.

This interface is usually specialized by each worker type: DedicatedWorkerGlobalScope for dedicated workers, SharedWorkerGlobalScope for shared workers, and ServiceWorkerGlobalScope for ServiceWorker. The self property returns the specialized scope for each context.

Properties

This interface inherits properties from the EventTarget interface and implements properties from the WindowOrWorkerGlobalScope and WindowEventHandlers mixins.

Standard properties

WorkerGlobalScope.navigator Read only

Returns the WorkerNavigator associated with the worker. It is a specific navigator object, mostly a subset of the Navigator for browsing scopes, but adapted to workers.

WorkerGlobalScope.self Read only

Returns a reference to the WorkerGlobalScope itself. Most of the time it is a specific scope like DedicatedWorkerGlobalScope, SharedWorkerGlobalScope or ServiceWorkerGlobalScope.

WorkerGlobalScope.location Read only

Returns the WorkerLocation associated with the worker. It is a specific location object, mostly a subset of the Location for browsing scopes, but adapted to workers.

Non-standard properties

WorkerGlobalScope.performance Read only

Returns the Performance associated with the worker. It is a regular performance object, except that only a subset of its property and methods are available to workers.

WorkerGlobalScope.console Read only

Returns the Console associated with the worker.

Properties implemented from elsewhere

WindowOrWorkerGlobalScope.caches Read only

Returns the CacheStorage object associated with the current context. This object enables functionality such as storing assets for offline use, and generating custom responses to requests.

WindowOrWorkerGlobalScope.indexedDB Read only

Provides a mechanism for applications to asynchronously access capabilities of indexed databases; returns an IDBFactory object.

WindowOrWorkerGlobalScope.isSecureContext Read only

Returns a boolean indicating whether the current context is secure (true) or not (false).

WindowOrWorkerGlobalScope.origin Read only

Returns the global object's origin, serialized as a string. (This does not yet appear to be implemented in any browser.)

Event Handlers

This interface inherits event handlers from the EventTarget interface (which includes those from GlobalEventHandlers), and implements event handlers from the WindowTimers mixin.

WorkerGlobalScope.onerror

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

WorkerGlobalScope.onoffline

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

WorkerGlobalScope.ononline

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

WorkerGlobalScope.onlanguagechange

An EventHandler fired at the global/worker scope object when the user's preferred languages change.

WorkerGlobalScope.onclose

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

WorkerGlobalScope.onrejectionhandled

An event handler for handled Promise rejection events.

WorkerGlobalScope.onunhandledrejection

An event handler for unhandled Promise rejection events.

Methods

This interface inherits methods from the EventTarget interface and implements properties from the WindowOrWorkerGlobalScope and WindowEventHandlers mixins.

Standard methods

WorkerGlobalScope.importScripts()

Imports one or more scripts into the worker's scope. You can specify as many as you'd like, separated by commas. For example: importScripts('foo.js', 'bar.js');

Non-standard methods

WorkerGlobalScope.dump()

Allows you to write a message to stdout — i.e. in your terminal. This is the same as Firefox's window.dump, but for workers.

Methods implemented from elsewhere

WindowOrWorkerGlobalScope.atob()

Decodes a string of data which has been encoded using base-64 encoding.

WindowOrWorkerGlobalScope.btoa()

Creates a base-64 encoded ASCII string from a string of binary data.

WindowOrWorkerGlobalScope.clearInterval()

Cancels the repeated execution set using WindowOrWorkerGlobalScope.setInterval().

WindowOrWorkerGlobalScope.clearTimeout()

Cancels the delayed execution set using WindowOrWorkerGlobalScope.setTimeout().

WindowOrWorkerGlobalScope.createImageBitmap()

Accepts a variety of different image sources, and returns a Promise which resolves to an ImageBitmap. Optionally the source is cropped to the rectangle of pixels originating at (sx, sy) with width sw, and height sh.

WindowOrWorkerGlobalScope.fetch()

Starts the process of fetching a resource from the network.

WindowOrWorkerGlobalScope.setInterval()

Schedules a function to execute every time a given number of milliseconds elapses.

WindowOrWorkerGlobalScope.setTimeout()

Schedules a function to execute in a given amount of time.

Deprecated methods

WorkerGlobalScope.close()

Discards any tasks queued in the WorkerGlobalScope's event loop, effectively closing this particular scope. In newer browser versions, close() is available on DedicatedWorkerGlobalScope and SharedWorkerGlobalScope instead. This change was made to stop close() being available on service workers, as it isn't supposed to be used there and always throws an exception when called (see bug 1336043).

Example

You won't access WorkerGlobalScope directly in your code; however, its properties and methods are inherited by more specific global scopes such as DedicatedWorkerGlobalScope and SharedWorkerGlobalScope. For example, you could import another script into the worker and print out the contents of the worker scope's navigator object using the following two lines:

importScripts('foo.js');
console.log(navigator);

Specifications

Browser compatibility

[1] Gecko 29 implemented this as WorkerConsole. Since version 30 it uses the regular Console.

See also

• Other global object interface: Window, DedicatedWorkerGlobalScope, SharedWorkerGlobalScope, , ServiceWorkerGlobalScope
• Other Worker-related interfaces: Worker, WorkerLocation, WorkerGlobalScope, and ServiceWorkerGlobalScope.
• Using web workers.