The ServiceWorkerRegistration
interface of the Service Worker 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
activated
. 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.navigationPreload
Read only- Returns the instance of
NavigationPreloadManager
associated with the current service worker registration. 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. ServiceWorkerRegistration.index
Read only- Returns a reference to the
ContentIndex
interface, for managing indexed content for offline viewing.
Unimplemented properties
serviceWorkerRegistration.periodicSync
Read only- Returns a reference to the
PeriodicSyncManager
interface, which manages periodic background synchronization processes. This was mentioned as an idea in the SW explainer at some point, but as yet has not been implemented anywhere.
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
. The service worker will finish any ongoing operations before it is unregistered.
Examples
In this example, the code first checks whether the browser supports service workers and if so registers one. Next, it adds an updatefound
listener in which it uses the service worker registration to listen for further changes to the service worker's state. If the service worker hasn't changed since the last time it was registered, then the updatefound
event will not be fired.
if ('serviceWorker' in navigator) { navigator.serviceWorker.register('/sw.js') .then(function(registration) { registration.addEventListener('updatefound', function() { // If updatefound is fired, it means that there's // a new service worker being installed. var installingWorker = registration.installing; console.log('A new service worker is being installed:', installingWorker); // You can listen for changes to the installing service worker's // state via installingWorker.onstatechange }); }) .catch(function(error) { console.log('Service worker registration failed:', error); }); } else { console.log('Service workers are not supported.'); }
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 | Living Standard | Adds the showNotification() method and the getNotifications() method. |
Web Background Synchronization | Living Standard | Adds the sync property. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
ServiceWorkerRegistration | Chrome Full support 40 | Edge
Full support
17
| Firefox
Full support
44
| IE No support No | Opera Full support 27 | Safari Full support 11.1 | WebView Android Full support 40 | Chrome Android Full support 40 | Firefox Android Full support 44 | Opera Android Full support 27 | Safari iOS Full support 11.3 | Samsung Internet Android Full support 4.0 |
active | Chrome Full support 40 | Edge
Full support
17
| Firefox
Full support
44
| IE No support No | Opera Full support 27 | Safari Full support 11.1 | WebView Android Full support 40 | Chrome Android Full support 40 | Firefox Android Full support 44 | Opera Android Full support 27 | Safari iOS Full support 11.3 | Samsung Internet Android Full support 4.0 |
backgroundFetch | Chrome Full support 74 | Edge No support No | Firefox No support No | IE No support No | Opera Full support 62 | Safari No support No | WebView Android No support No | Chrome Android Full support 74 | Firefox Android No support No | Opera Android Full support 53 | Safari iOS No support No | Samsung Internet Android Full support 11.0 |
getNotifications | Chrome Full support 40 | Edge
Full support
17
| Firefox
Full support
46
| IE No support No | Opera Full support 27 | Safari Full support 11.1 | WebView Android No support No | Chrome Android Full support 40 | Firefox Android Full support 46 | Opera Android Full support 27 | Safari iOS Full support 11.3 | Samsung Internet Android Full support 4.0 |
installing | Chrome Full support 40 | Edge
Full support
17
| Firefox
Full support
44
| IE No support No | Opera Full support 27 | Safari Full support 11.1 | WebView Android Full support 40 | Chrome Android Full support 40 | Firefox Android Full support 44 | Opera Android Full support 27 | Safari iOS Full support 11.3 | Samsung Internet Android Full support 4.0 |
navigationPreload | Chrome Full support 59 | Edge
Full support
17
| Firefox
Full support
44
| IE No support No | Opera Full support 46 | Safari Full support 11.1 | WebView Android Full support 59 | Chrome Android Full support 59 | Firefox Android Full support 44 | Opera Android Full support 43 | Safari iOS Full support 11.3 | Samsung Internet Android Full support 4.0 |
onupdatefound | Chrome Full support 40 | Edge
Full support
17
| Firefox
Full support
44
| IE No support No | Opera Full support 27 | Safari Full support 11.1 | WebView Android Full support 40 | Chrome Android Full support 40 | Firefox Android Full support 44 | Opera Android Full support 27 | Safari iOS Full support 11.3 | Samsung Internet Android Full support 4.0 |
paymentManager | Chrome
Full support
56
| Edge
Full support
≤79
| Firefox ? | IE No support No | Opera Full support Yes | Safari ? | WebView Android Full support Yes | Chrome Android
Full support
56
| Firefox Android ? | Opera Android Full support Yes | Safari iOS ? | Samsung Internet Android No support No |
periodicSync | Chrome Full support 80 | Edge Full support 80 | Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android Full support 80 | Chrome Android Full support 80 | Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android No support No |
pushManager | Chrome Full support 40 | Edge
Full support
17
| Firefox
Full support
44
| IE No support No | Opera Full support 27 | Safari Full support 11.1 | WebView Android No support No | Chrome Android Full support 40 | Firefox Android Full support 44 | Opera Android Full support 27 | Safari iOS Full support 11.3 | Samsung Internet Android Full support 4.0 |
scope | Chrome Full support 40 | Edge
Full support
17
| Firefox
Full support
44
| IE No support No | Opera Full support 27 | Safari Full support 11.1 | WebView Android Full support 40 | Chrome Android Full support 40 | Firefox Android Full support 44 | Opera Android Full support 27 | Safari iOS No support No | Samsung Internet Android Full support 4.0 |
showNotification | Chrome Full support 40 | Edge
Full support
17
| Firefox
Full support
46
| IE No support No | Opera Full support 27 | Safari No support No | WebView Android Full support 40 | Chrome Android Full support 40 | Firefox Android Full support 46 | Opera Android Full support 27 | Safari iOS No support No | Samsung Internet Android Full support 4.0 |
sync | Chrome Full support 49 | Edge Full support ≤79 | Firefox No support No | IE No support No | Opera Full support 36 | Safari No support No | WebView Android Full support 49 | Chrome Android Full support 49 | Firefox Android No support No | Opera Android Full support 36 | Safari iOS No support No | Samsung Internet Android Full support 4.0 |
unregister | Chrome Full support 40 | Edge
Full support
17
| Firefox
Full support
44
| IE No support No | Opera Full support 27 | Safari Full support 11.1 | WebView Android Full support 40 | Chrome Android Full support 40 | Firefox Android Full support 44 | Opera Android Full support 27 | Safari iOS Full support 11.3 | Samsung Internet Android Full support 4.0 |
update | Chrome
Full support
45
| Edge
Full support
17
| Firefox
Full support
44
| IE No support No | Opera
Full support
32
| Safari Full support 11.1 | WebView Android
Full support
45
| Chrome Android
Full support
45
| Firefox Android Full support 44 | Opera Android
Full support
32
| Safari iOS No support No | Samsung Internet Android
Full support
4.0
|
updateViaCache | Chrome Full support 68 | Edge Full support 18 | Firefox Full support 57 | IE No support No | Opera Full support Yes | Safari Full support 11.1 | WebView Android Full support 68 | Chrome Android Full support 68 | Firefox Android Full support 57 | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung Internet Android Full support 10.0 |
waiting | Chrome Full support 40 | Edge
Full support
17
| Firefox
Full support
44
| IE No support No | Opera Full support 27 | Safari Full support 11.1 | WebView Android Full support 40 | Chrome Android Full support 40 | Firefox Android Full support 44 | Opera Android Full support 27 | Safari iOS No support No | Samsung Internet Android Full support 4.0 |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.
- Non-standard. Expect poor cross-browser support.
- Non-standard. Expect poor cross-browser support.
- See implementation notes.
- See implementation notes.
- User must explicitly enable this feature.
- User must explicitly enable this feature.