ServiceWorkerContainer.getRegistration()

The getRegistration() method of the ServiceWorkerContainer interface gets a ServiceWorkerRegistration object whose scope URL matches the provided document URL. The method returns a Promise that resolves to a ServiceWorkerRegistration or undefined.

Syntax

serviceWorkerContainer.getRegistration(scope).then(function(serviceWorkerRegistration) { ... });

Parameters

scope Optional
A unique identifier for a service worker registration — the scope URL of the registration object you want to return. This is usually a relative URL.

Return value

A Promise that resolves to a ServiceWorkerRegistration object or undefined.

Example

navigator.serviceWorker.getRegistration('/app').then(function(registration) {
  if(registration){
    document.querySelector('#status').textContent = 'ServiceWorkerRegistration found.'; 
  }
});

Specifications

Specification Status Comment
Service Workers
The definition of 'ServiceWorkerContainer: getRegistration' in that specification.
Working Draft Initial definition.

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
getRegistration
Experimental
Chrome Full support 40Edge Full support 17
Full support 17
Full support 16
Disabled
Disabled From version 16: this feature is behind the Enable service workers preference.
Firefox Full support 44
Notes
Full support 44
Notes
Notes Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
IE No support NoOpera Full support 27Safari Full support 11.1WebView Android Full support 40Chrome Android Full support 40Firefox Android Full support 44Opera Android Full support 27Safari iOS Full support 11.3Samsung Internet Android Full support 4.0

Legend

Full support
Full support
No support
No support
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
See implementation notes.
See implementation notes.
User must explicitly enable this feature.
User must explicitly enable this feature.