PeriodicSyncManager: unregister() method

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

js
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.

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

Specifications

See also