ServiceWorkerRegistration
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 ServiceWorkerRegistion
interface of the ServiceWorker API represents the service worker registration. You register a service worker to control one or more pages that share the same origin.
The lifetime of a service worker registration is beyond that of the ServiceWorkerRegistration
objects that represent them within the lifetime of their corresponding service worker clients. The browser maintains a persistent list of active ServiceWorkerRegistration
objects.
Note: This feature is available in Web Workers.
Properties
Also implements properties from its parent interface, EventTarget
.
ServiceWorkerRegistration.scope
Read only- Returns a unique identifier for a service worker registration. This must be on the same origin as the document that registers the
ServiceWorker
. ServiceWorkerRegistration.installing
Read only- Returns a service worker whose state is
installing
. This is initially set tonull
. ServiceWorkerRegistration.waiting
Read only- Returns a service worker whose state is
installed
. This is initially set tonull
. ServiceWorkerRegistration.active
Read only- Returns a service worker whose state is either
activating
oractivated
. This is initially set tonull
. An active worker will control aServiceWorkerClient
if the client's URL falls within the scope of the registration (thescope
option set whenServiceWorkerContainer.register
is first called.) serviceWorkerRegistration.periodicSync
Read only- Returns a reference to the
PeriodicSyncManager
interface, which manages periodic background synchronization processes. ServiceWorkerRegistration.pushManager
Read only- Returns a reference to the
PushManager
interface for managing push subscriptions including subscribing, getting an active subscription, and accessing push permission status. ServiceWorkerRegistration.sync
Read only- Returns a reference to the
SyncManager
interface, which manages background synchronization processes.
Event handlers
ServiceWorkerRegistration.onupdatefound
Read only- An
EventListener
property called whenever an event of typeupdatefound
is fired; it is fired any time theServiceWorkerRegistration.installing
property acquires a new service worker.
Methods
Also implements methods from its parent interface, EventTarget
.
ServiceWorkerRegistration.getNotifications()
- Returns a
Promise
that resolves to an array ofNotification
objects. ServiceWorkerRegistration.showNotification()
- Displays the notification with the requested title.
ServiceWorkerRegistration.update()
- Checks the server for an updated version of the service worker without consulting caches.
ServiceWorkerRegistration.unregister()
- Unregisters the service worker registration and returns a promise (see
Promise
). The service worker will finish any ongoing operations before it is unregistered.
Examples
This code snippet is from the service worker registration-events sample (live demo). The code checks to see if the browser supports service workers and if there's currently a service worker handling requests on this page for the current navigation.
Any new service workers are registered; if there's an existing service worker, the code overrides its default scope so that the registration applies to the current directory and everything underneath it. The example also reports any registration failures.
if ('serviceWorker' in navigator) { document.querySelector('#availability').innerText = 'are'; document.querySelector('#controlled').innerText = navigator.serviceWorker.controller ? 'is' : 'is not'; navigator.serviceWorker.register('service-worker.js', {scope: './'}).then(function(registration) { document.querySelector('#register').textContent = 'succeeded'; }).catch(function(error) { document.querySelector('#register').textContent = 'failed: ' + error; }); } else { document.querySelector('#availability').innerText = 'are not'; }
Specifications
Specification | Status | Comment |
---|---|---|
Service Workers The definition of 'ServiceWorkerRegistration' in that specification. |
Working Draft | Initial definition. |
Push API The definition of 'PushManager' in that specification. |
Working Draft | Adds the pushManager property. |
Notifications API | Recommendation | Adds the showNotification() method and the getNotifications() method. |
Web Background Synchronization | Living Standard | Adds the sync property. |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | 40.0 | 44.0 (44.0)[1] | No support | ? | No support |
Available in web workers | (Yes) | 44.0 (44.0)[1] | No support | ? | No support |
getNotifications() , showNotification() |
(Yes) | 46.0 (46.0)[1] | No support | ? | No support |
sync property |
49.0 |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|---|
Basic support | No support | No support | 44.0 (44.0) | (Yes) | No support | ? | No support | 40.0 |
Available in web workers | No support | No support | 44.0 (44.0) | (Yes) | No support | ? | No support | (Yes) |
getNotifications() , showNotification() |
No support | No support | 46.0 (46.0) | (Yes) | No support | ? | No support | (Yes) |
sync property |
No support | No support | 49.0 |
[1] Service workers (and Push) have been disabled in the Firefox 45 Extended Support Release (ESR.)
See also
- Using Service Workers
- Service workers basic code example
- Is ServiceWorker ready?
Promise
- Using web workers
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/serviceworkerregistration