This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The ServiceWorkerRegistration 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 to null.
ServiceWorkerRegistration.waiting Read only
Returns a service worker whose state is waiting. This is initially set to null.
ServiceWorkerRegistration.active Read only
Returns a service worker whose state is either activating or activated. This is initially set to null. An active worker will control a ServiceWorkerClient if the client's URL falls within the scope of the registration (the scope option set when ServiceWorkerContainer.register is first called.)
ServiceWorkerRegistration.navigationPreload Read only
Returns the instance of NavigationPreloadManager associated with the current service worker registration.
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 type updatefound is fired; it is fired any time the ServiceWorkerRegistration.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 of Notification 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 and updatefound event 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, than 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

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support40

161

17

442 No27 No
scope40

161

17

442 No27 No
installing40

161

17

442 No27 No
waiting40

161

17

442 No27 No
active40

161

17

442 No27 No
navigationPreload59

161

17

442 No46 No
periodicSync40

161

17

442 No27 No
pushManager40

161

17

442 No27 No
sync49

161

17

442 No36 No
onupdatefound40

161

17

442 No27 No
getNotifications40

161

17

462 No27 No
showNotification40

161

17

462 No27 No
update453 4

161

17

442 No325 6 No
unregister40

161

17

442 No27 No
updateViaCache ? ? ? ? ? ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support4040 ?4427 No4.0
scope4040 ?4427 No4.0
installing4040 ?4427 No4.0
waiting4040 ?4427 No4.0
active4040 ?4427 No4.0
navigationPreload5959 ?4446 No4.0
periodicSync4040 ?4427 No4.0
pushManager4040 ?4427 No4.0
sync4949 ?4436 No4.0
onupdatefound4040 ?4427 No4.0
getNotifications4040 ?4627 No4.0
showNotification4040 ?4627 No4.0
update453 4453 4 ?44325 6 No4.0
unregister4040 ?4427 No4.0
updateViaCache ? ? ? ? ? ? ?

1. From version 16: this feature is behind the Enable service workers preference.

2. Service workers (and Push) have been disabled in the Firefox 45 and 52 Extended Support Releases (ESR).

3. Starting with Chrome 46, update() returns a promise that resolves with 'undefined' if the operation completed successfully or there was no update, and rejects if update failed. If the new worker ran but installation failed, the promise still resolves. Formerly, it raised an exception.

4. Before Chrome 48, this method always bypassed the browser cache. Starting with Chrome 48, it only bypasses the cache when the previous service worker check was more than twenty-four hours ago.

5. Starting with Opera 33, update() returns a promise that resolves with 'undefined' if the operation completed successfully or there was no update, and rejects if update failed. If the new worker ran but installation failed, the promise still resolves. Formerly, it raised an exception.

6. Before Opera 35, this method always bypassed the browser cache. Starting with Opera 35, it only bypasses the cache when the previous service worker check was more than twenty-four hours ago.

See also

Document Tags and Contributors

Last updated by: ExE-Boss,