W3cubDocs

/DOM

ServiceWorkerRegistration.unregister

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

The unregister method of the ServiceWorkerRegistration interface unregisters the service worker registration and returns a Promise. The promise will resolve to false if no registration was found, otherwise it resolves to true irrespective of whether unregistration happened or not (it may not unregister if someone else just called ServiceWorkerContainer.register with the same scope.) The service worker will finish any ongoing operations before it is unregistered.

Note: This feature is available in Web Workers.

Syntax

ServiceWorkerRegistration.unregister().then(function(boolean) {
});

Parameters

None.

Returns

Promise resolves with a boolean indicating whether the service worker has unregistered or not.

Example

The following simple example registers a service worker example, but then immediately unregisters it again:

if ('serviceWorker' in navigator) {
  navigator.serviceWorker.register('/sw-test/sw.js', {scope: 'sw-test'}).then(function(registration) {
    // registration worked
    console.log('Registration succeeded.');
    registration.unregister().then(function(boolean) {
      // if boolean = true, unregister is successful
    });
  }).catch(function(error) {
    // registration failed
    console.log('Registration failed with ' + error);
  });
};

Specifications

Specification Status Comment
Service Workers
The definition of 'ServiceWorkerRegistration.unregister()' in that specification.
Editor's Draft Initial definition.

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 40.0 (Yes)[2] 44.0 (44.0)[1] No support ? No support
Available in web workers (Yes) ? 44.0 (44.0)[1] No support ? No support
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support No support 44.0 (44.0) (Yes) No support ? No support 40.0
Available in web workers No support No support (Yes) ? No support ? No support (Yes)

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

[2] Service workers is available in Microsoft Edge starting EdgeHTML 16 behind a flag.

See also

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/unregister