PeriodicSyncManager.unregister()

Draft: This page is not complete.

The unregister() method of the PeriodicSyncManager interface unregisters the periodic sync request corresponding to the specified tag and returns a Promise that resolves when unregistration completes.

Syntax

var unregister = PeriodicSyncManager.unregister(tag);

Parameters

tag

The unique String descriptor for the specific background sync.

Return value

A resolved Promise.

Exceptions

None.

Examples

The following example removes a periodic sync to stop syncing articles in the background.

navigator.serviceWorker.ready.then(registration => {
  registration.periodicSync.unregister('get-latest-news');
});

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
unregister
80
80
No
No
67
No
80
80
No
57
No
13.0

See also

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/PeriodicSyncManager/unregister