ServiceWorkerRegistration: periodicSync property

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

The periodicSync read-only property of the ServiceWorkerRegistration interface returns a reference to the PeriodicSyncManager interface, which allows for registering of tasks to run at specific intervals.

Value

A PeriodicSyncManager object.

Examples

You can access the property from either your main script or the registered service worker.

Here is an example from the main script:

// reference registration
const registration = await navigator.serviceWorker.ready;

// feature detection
if ("periodicSync" in registration) {
  // Background Periodic Sync functionality
  const periodicSync = registration.periodicSync;
}

From the service worker:

// service worker script

const periodicSync = self.registration.periodicSync;

Specifications

Specification
Web Periodic Background Synchronization
# dom-serviceworkerregistration-periodicsync

Browser compatibility

BCD tables only load in the browser

See also