Web/API/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 WorkersThe definition of 'ServiceWorkerContainer: getRegistration' in that specification.	Working Draft	Initial definition.

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
getRegistration Experimental'	Chrome Full support 40	Edge 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 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

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.

ServiceWorkerContainer.getRegistration() by Mozilla Contributors is licensed under CC-BY-SA 2.5.