web api instance method
PeriodicSyncManager: unregister() method
Limited availabilityAvailable in workers
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
unregister(tag)
Parameters
- tag
- : The unique
Stringdescriptor for the specific background sync.
- : The unique
Return value
Returns a Promise that resolves with undefined.
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
SpecificationsStandards references are available on the canonical MDN page.
Browser compatibility
Browser compatibilityCompatibility data is available on the canonical MDN page.