PeriodicSyncManager: register() 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 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.

Syntax

js
register(tag, options)

Parameters

tag

A unique String identifier.

options Optional

An Object containing the following optional data:

minInterval

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

Return value

Returns a Promise that resolves with undefined.

Exceptions

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

Examples

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

js
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!");
  }
}

Specifications

See also