1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
---
title: SharedWorkerGlobalScope
slug: Web/API/SharedWorkerGlobalScope
tags:
- API
- Interface
- NeedsTranslation
- Reference
- SharedWorkerGlobalScope
- TopicStub
- Web Workers
translation_of: Web/API/SharedWorkerGlobalScope
---
<div>{{APIRef("Web Workers API")}}</div>
<p>The <strong><code>SharedWorkerGlobalScope</code></strong> object (the {{domxref("SharedWorker")}} global scope) is accessible through the {{domxref("window.self","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 <a href="/en-US/docs/Web/JavaScript/Reference">JavaScript Reference</a>. See the complete list of <a href="/en-US/docs/Web/API/Web_Workers_API/Functions_and_classes_available_to_workers">functions available to workers</a>.</p>
<h2 id="Properties">Properties</h2>
<p><em>This interface inherits properties from the {{domxref("WorkerGlobalScope")}} interface, and its parent {{domxref("EventTarget")}}, and therefore implements properties from {{domxref("WindowTimers")}}, {{domxref("WindowBase64")}}, and {{domxref("WindowEventHandlers")}}.</em></p>
<dl>
<dt>{{domxref("SharedWorkerGlobalScope.name")}} {{readOnlyinline}}</dt>
<dd>The name that the {{domxref("SharedWorker")}} was (optionally) given when it was created using the {{domxref("SharedWorker.SharedWorker", "SharedWorker()")}} constructor. This is mainly useful for debugging purposes.</dd>
<dt>{{domxref("SharedWorkerGlobalScope.applicationCache")}} {{readOnlyinline}} {{deprecated_inline}}</dt>
<dd>This property returns the {{domxref("ApplicationCache")}} object for the worker (see <a href="/en-US/docs/Web/HTML/Using_the_application_cache">Using the application cache</a>).</dd>
</dl>
<h3 id="Properties_inherited_from_WorkerGlobalScope">Properties inherited from WorkerGlobalScope</h3>
<dl>
<dt>{{domxref("WorkerGlobalScope.self")}}</dt>
<dd>Returns an object reference to the <code>DedicatedWorkerGlobalScope</code> object itself.</dd>
<dt>{{domxref("WorkerGlobalScope.console")}} {{readOnlyinline}}</dt>
<dd>Returns the {{domxref("Console")}} associated with the worker.</dd>
<dt>{{domxref("WorkerGlobalScope.location")}} {{readOnlyinline}}</dt>
<dd>Returns the {{domxref("WorkerLocation")}} associated with the worker. <code>WorkerLocation</code> is a specific location object, mostly a subset of the {{domxref("Location")}} for browsing scopes, but adapted to workers.</dd>
<dt>{{domxref("WorkerGlobalScope.navigator")}} {{readOnlyinline}}</dt>
<dd>Returns the {{domxref("WorkerNavigator")}} associated with the worker. <code>WorkerNavigator</code> is a specific navigator object, mostly a subset of the {{domxref("Navigator")}} for browsing scopes, but adapted to workers.</dd>
<dt>{{domxref("WorkerGlobalScope.performance")}} {{readOnlyinline}} {{Non-standard_inline}}</dt>
<dd>Returns the {{domxref("Performance")}} object associated with the worker, which is a regular performance object, but with a subset of its properties and methods available.</dd>
</dl>
<h3 id="Event_handlers">Event handlers</h3>
<p><em>This interface inherits event handlers from the {{domxref("WorkerGlobalScope")}} interface, and its parent {{domxref("EventTarget")}}, and therefore implements event handlers from {{domxref("WindowTimers")}}, {{domxref("WindowBase64")}}, and {{domxref("WindowEventHandlers")}}.</em></p>
<dl>
<dt>{{domxref("SharedWorkerGlobalScope.onconnect")}}</dt>
<dd>Is an {{event("Event_handlers")}} representing the code to be called when the {{event("connect")}} event is raised — that is, when a {{domxref("MessagePort")}} connection is opened between the associated {{domxref("SharedWorker")}} and the main thread.</dd>
</dl>
<h2 id="Methods">Methods</h2>
<p><em>This interface inherits methods from the {{domxref("WorkerGlobalScope")}} interface, and its parent {{domxref("EventTarget")}}, and therefore implements methods from {{domxref("WindowTimers")}}, {{domxref("WindowBase64")}}, and {{domxref("WindowEventHandlers")}}.</em></p>
<dl>
<dt>{{domxref("SharedWorkerGlobalScope.close()")}}</dt>
<dd>Discards any tasks queued in the <code>SharedWorkerGlobalScope</code>'s event loop, effectively closing this particular scope.</dd>
</dl>
<h3 id="Inherited_from_WorkerGlobalScope">Inherited from WorkerGlobalScope</h3>
<dl>
<dt>{{domxref("WorkerGlobalScope.close()")}} {{deprecated_inline}}</dt>
<dd>Discards any tasks queued in the <code>WorkerGlobalScope</code>'s event loop, effectively closing this particular scope.</dd>
<dt>{{domxref("WorkerGlobalScope.dump()")}} {{non-standard_inline}}</dt>
<dd>Allows you to write a message to stdout — i.e. in your terminal. This is the same as Firefox's {{domxref("window.dump")}}, but for workers.</dd>
<dt>{{domxref("WorkerGlobalScope.importScripts()")}}</dt>
<dd>Imports one or more scripts into the worker's scope. You can specify as many as you'd like, separated by commas. For example:<code> importScripts('foo.js', 'bar.js');</code></dd>
</dl>
<h3 id="Implemented_from_other_places">Implemented from other places</h3>
<dl>
<dt>{{domxref("WindowBase64.atob()")}}</dt>
<dd>Decodes a string of data which has been encoded using base-64 encoding.</dd>
<dt>{{domxref("WindowBase64.btoa()")}}</dt>
<dd>Creates a base-64 encoded ASCII string from a string of binary data.</dd>
<dt>{{domxref("WindowTimers.clearInterval()")}}</dt>
<dd>Cancels the repeated execution set using {{domxref("WindowTimers.setInterval()")}}.</dd>
<dt>{{domxref("WindowTimers.clearTimeout()")}}</dt>
<dd>Cancels the repeated execution set using {{domxref("WindowTimers.setTimeout()")}}.</dd>
<dt>{{domxref("WindowTimers.setInterval()")}}</dt>
<dd>Schedules the execution of a function every X milliseconds.</dd>
<dt>{{domxref("WindowTimers.setTimeout()")}}</dt>
<dd>Sets a delay for executing a function.</dd>
</dl>
<h2 id="Events">Events</h2>
<p>Listen to this event using <code><a href="/en-US/docs/Web/API/EventTarget/addEventListener">addEventListener()</a></code> or by assigning an event listener to the <code>on<em>eventname</em></code> property of this interface.</p>
<dl>
<dt><code><a href="/en-US/docs/Web/API/SharedWorkerGlobalScope/connect_event">connect</a></code></dt>
<dd>Fired on shared workers when a new client connects.<br>
Also available via the <code><a href="/en-US/docs/Web/API/SharedWorkerGlobalScope/onconnect">onconnect</a></code> property.</dd>
</dl>
<h2 id="Specifications">Specifications</h2>
<table class="standard-table">
<thead>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
<th scope="col">Comment</th>
</tr>
</thead>
<tbody>
<tr>
<td>{{SpecName('HTML WHATWG', '#sharedworkerglobalscope', 'SharedWorkerGlobalScope')}}</td>
<td>{{Spec2('HTML WHATWG')}}</td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility">Browser compatibility</h2>
<p>{{Compat("api.SharedWorkerGlobalScope")}}</p>
<h2 id="See_also">See also</h2>
<ul>
<li>{{domxref("SharedWorker")}}</li>
<li>{{domxref("WorkerGlobalScope")}}</li>
<li><a href="/en-US/docs/Web/API/Web_Workers_API/Using_web_workers">Using Web workers</a></li>
<li><a href="/en-US/docs/Web/Guide/Needs_categorization/Functions_available_to_workers">Functions available to workers</a></li>
</ul>
|
