ServiceWorkerContainer: getRegistration() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2018.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Web Workers.

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

Syntax

js
getRegistration()
getRegistration(clientURL)

Parameters

clientURL Optional

The registration whose scope matches this URL will be returned. Relative URLs are resolved with the current client as the base. If this parameter is not provided, the current client's URL will be used by default.

Return value

A Promise that resolves to a ServiceWorkerRegistration object or undefined.

Examples

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

Specifications

Specification
Service Workers
# navigator-service-worker-getRegistration

Browser compatibility

BCD tables only load in the browser