The SharedWorkerGlobalScope object (the SharedWorker global scope) is accessible through the self keyword. Some additional global functions, namespaces objects, and constructors, not typically associated with the worker global scope, but available on it, are listed in the JavaScript Reference. See the complete list of functions available to workers.
Properties
This interface inherits properties from the WorkerGlobalScope interface, and its parent EventTarget, and therefore implements properties from WindowTimers, WindowBase64, and WindowEventHandlers.
SharedWorkerGlobalScope.nameRead only- The name that the
SharedWorkerwas (optionally) given when it was created using theSharedWorker()constructor. This is mainly useful for debugging purposes. SharedWorkerGlobalScope.applicationCacheRead only '- This property returns the
ApplicationCacheobject for the worker (see Using the application cache).
Properties inherited from WorkerGlobalScope
WorkerGlobalScope.self- Returns an object reference to the
DedicatedWorkerGlobalScopeobject itself. WorkerGlobalScope.consoleRead only- Returns the
Consoleassociated with the worker. WorkerGlobalScope.locationRead only- Returns the
WorkerLocationassociated with the worker.WorkerLocationis a specific location object, mostly a subset of theLocationfor browsing scopes, but adapted to workers. WorkerGlobalScope.navigatorRead only- Returns the
WorkerNavigatorassociated with the worker.WorkerNavigatoris a specific navigator object, mostly a subset of theNavigatorfor browsing scopes, but adapted to workers. WorkerGlobalScope.performanceRead only '- Returns the
Performanceobject associated with the worker, which is a regular performance object, but with a subset of its properties and methods available.
Event handlers
This interface inherits event handlers from the WorkerGlobalScope interface, and its parent EventTarget, and therefore implements event handlers from WindowTimers, WindowBase64, and WindowEventHandlers.
SharedWorkerGlobalScope.onconnect- Is an
EventHandlerrepresenting the code to be called when theconnectevent is raised — that is, when aMessagePortconnection is opened between the associatedSharedWorkerand the main thread.
Methods
This interface inherits methods from the WorkerGlobalScope interface, and its parent EventTarget, and therefore implements methods from WindowTimers, WindowBase64, and WindowEventHandlers.
SharedWorkerGlobalScope.close()- Discards any tasks queued in the
SharedWorkerGlobalScope's event loop, effectively closing this particular scope.
Inherited from WorkerGlobalScope
WorkerGlobalScope.close()'- Discards any tasks queued in the
WorkerGlobalScope's event loop, effectively closing this particular scope. 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. 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');
Implemented from other places
WindowBase64.atob()- Decodes a string of data which has been encoded using base-64 encoding.
WindowBase64.btoa()- Creates a base-64 encoded ASCII string from a string of binary data.
WindowTimers.clearInterval()- Cancels the repeated execution set using
WindowTimers.setInterval(). WindowTimers.clearTimeout()- Cancels the repeated execution set using
WindowTimers.setTimeout(). WindowTimers.setInterval()- Schedules the execution of a function every X milliseconds.
WindowTimers.setTimeout()- Sets a delay for executing a function.
Events
Listen to this event using addEventListener() or by assigning an event listener to the oneventname property of this interface.
connect- Fired on shared workers when a new client connects. Also available via the
onconnectproperty.
Specifications
| Specification | Status | Comment |
|---|---|---|
| HTML Living StandardThe definition of 'SharedWorkerGlobalScope' in that specification. | Living Standard |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
See also
SharedWorkerGlobalScope by Mozilla Contributors is licensed under CC-BY-SA 2.5.
