ServiceWorkerContainer.register()
This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.
The register()
method of the ServiceWorkerContainer
interface creates or updates a ServiceWorkerRegistration
for the given scriptURL
.
If successful, a service worker registration ties the provided script URL to a scope, which is subsequently used for navigation matching. If the method can't return a ServiceWorkerRegistration
, it returns a Promise
. You can call this method unconditionally from the controlled page, i.e., you don't need to first check whether there's an active registration.
Syntax
ServiceWorkerContainer.register(scriptURL, options)
.then(function(ServiceWorkerRegistration) { ... });
Parameters
scriptURL
- The URL of the service worker script.
options
Optional
- An options object to provide options upon registration. Currently available options are:
scope
: AUSVString
representing a URL that defines a service worker's registration scope; what range of URLs a service worker can control. This is usually a relative URL. The default value is the URL you'd get if you resolved './' using the service worker script's location as the base.
Returns
A Promise
that resolves to a ServiceWorkerRegistration
object.
Example
if ('serviceWorker' in navigator) { navigator.serviceWorker.register('service-worker.js', {scope: './'}).then(function(registration) { document.querySelector('#status').textContent = 'succeeded'; }).catch(function(error) { document.querySelector('#status').textContent = error; }); } else { // The current browser doesn't support service workers. var aElement = document.createElement('a'); aElement.href = 'http://www.chromium.org/blink/serviceworker/service-worker-faq'; aElement.textContent = 'unavailable'; document.querySelector('#status').appendChild(aElement); }
Specifications
Specification | Status | Comment |
---|---|---|
Service Workers The definition of 'ServiceWorkerContainer' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | 40.0 | 44.0 (44.0)[1] | No support | 24 | No support |
Feature | Android | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|
Basic support | ? | 44.0 (44.0) | (Yes) | No support | ? | No support | 40.0 |
[1] Service workers (and Push) have been disabled in the Firefox 45 Extended Support Release (ESR.)
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/serviceworkercontainer/register