PeriodicSyncManager: register() method

Limited availability

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

See full compatibility

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

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:

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

Specification
Web Periodic Background Synchronization # dom-periodicsyncmanager-register

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
`register` Experimental	Chrome – Full support Chrome 80 (Release date: 2020-02-04) footnote Full support	Edge – Full support Edge 80 (Release date: 2020-02-07) footnote Full support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 67 (Release date: 2020-03-03) footnote Full support	Safari – No support Safari footnote No support	Chrome Android – Full support Chrome Android 80 (Release date: 2020-02-04) footnote Full support	Firefox for Android – No support Firefox for Android footnote No support	Opera Android – Full support Opera Android 57 (Release date: 2020-03-30) footnote Full support	Safari on iOS – No support Safari on iOS footnote No support	Samsung Internet – Full support Samsung Internet 13 (Release date: 2020-12-02) footnote Full support	WebView Android – No support WebView Android footnote No support	WebView on iOS – No support WebView on iOS footnote No support

Tip: you can click/tap on a cell for more information.

Full support: Full support
No support: No support
: Experimental. Expect behavior to change in the future.

PeriodicSyncManager: register() method

Legend