PeriodicSyncManager.register()

The register() method of the PeriodicSyncManager interface registers a periodic sync request with the browser with the specified tag and options. It returns a Promise that resolves when the registration completes.

tag

A unique String identifier

BackgroundSyncOptions Optional

An Object containing the following optional data:

• minInterval: The minimum interval time, in milliseconds, at which the periodic sync should occur.

Returns a Promise that resolves with undefined

InvalidStateError DOMException

Returned if there is no active ServiceWorker present.

NotAllowedError DOMException

Returned if permission for background periodic sync is not granted.

InvalidAccessError DOMException

Returned if the active window is not the main window (not of auxiliary or top-level type).

The following asynchronous function registers a periodic background sync at a minimum interval of one day from a browsing context:

async function registerPeriodicNewsCheck() {
  const registration = await navigator.serviceWorker.ready;
  try {
    await registration.periodicSync.register('fetch-news', {
      minInterval: 24 * 60 * 60 * 1000,
    });
  } catch {
    console.log('Periodic Sync could not be registered!');
  }
}

• Richer offline experiences with the Periodic Background Sync API
• A Periodic Background Sync demo app