W3cubDocs

/Web APIs

PeriodicSyncManager: unregister() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

Note: This feature is available in Web 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 String descriptor for the specific background sync.

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

Specification
Web Periodic Background Synchronization> # dom-periodicsyncmanager-unregister>

Browser compatibility

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