ServiceWorkerRegistration: periodicSync property

{{APIRef("Service Workers API")}}{{SeeCompatTable}}{{SecureContext_Header}}{{AvailableInWorkers}}

The periodicSync read-only property of the {{domxref("ServiceWorkerRegistration")}} interface returns a reference to the {{domxref('PeriodicSyncManager')}} interface, which allows for registering of tasks to run at specific intervals.

Value

A {{domxref('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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Richer offline experiences with the Periodic Background Sync API