Limited availability
The SharedWorker()
constructor creates a SharedWorker
object that executes the script at the specified URL. This script must obey the same-origin policy.
Note: There is disagreement among browser manufacturers about whether a data URL is of the same origin or not. Although Firefox 10.0 and later accept data URLs, that's not the case in all other browsers.
Syntaxnew SharedWorker(aURL)
new SharedWorker(aURL, name)
new SharedWorker(aURL, options)
Parameters
aURL
A string representing the URL of the script the worker will execute. It must obey the same-origin policy.
name
Optional
A string specifying an identifying name for the SharedWorkerGlobalScope
representing the scope of the worker, which is useful for creating new instances of the same SharedWorker and debugging.
options
Optional
An object containing option properties that can set when creating the object instance. Available properties are as follows:
type
A string specifying the type of worker to create. The value can be classic
or module
. If not specified, the default used is classic
.
credentials
A string specifying the type of credentials to use for the worker. The value can be omit
, same-origin
, or include
. If not specified, or if type is classic
, the default used is omit
(no credentials required).
name
A string specifying an identifying name for the SharedWorkerGlobalScope
representing the scope of the worker, which is mainly useful for debugging purposes.
sameSiteCookies
A string indicating which SameSite
cookies should be available to the worker. Can have one of the following two values:
SameSite=Strict
, SameSite=Lax
, and SameSite=None
cookies will all be available to the worker. This option is only supported in first-party contexts, and is the default in first-party contexts.
Only SameSite=None
cookies will be available to the worker. This option is supported in first-party and third-party contexts, and is the default in third-party contexts.
SecurityError
DOMException
Thrown if the document is not allowed to start workers, for example if the URL has an invalid syntax or if the same-origin policy is violated, or if the sameSiteCookies
value is not supported in the given context.
NetworkError
DOMException
Thrown if the MIME type of the worker script is incorrect. It should always be text/javascript
(for historical reasons other JavaScript MIME types may be accepted).
SyntaxError
DOMException
Thrown if aURL
cannot be parsed.
The following code snippet shows creation of a SharedWorker
object using the SharedWorker()
constructor and subsequent usage of the object:
const myWorker = new SharedWorker("worker.js");
myWorker.port.start();
[first, second].forEach((input) => {
input.onchange = () => {
myWorker.port.postMessage([first.value, second.value]);
console.log("Message posted to worker");
};
});
myWorker.port.onmessage = (e) => {
result1.textContent = e.data;
console.log("Message received from worker");
};
For a full example, see our Basic shared worker example (run shared worker.)
Specifications Browser compatibility See alsoSharedWorker
interface it belongs to.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4