ContextQMD
Back to Content

ServiceWorkerGlobalScope: periodicsync event

files/en-us/web/api/serviceworkerglobalscope/periodicsync_event/index.md

latest1.6 KB
Original Source

{{APIRef("Periodic Background Sync")}}{{SeeCompatTable}}{{SecureContext_Header}}{{AvailableInWorkers("service")}}

The periodicsync event of the {{domxref("ServiceWorkerGlobalScope")}} interface is fired at timed intervals, specified when registering a {{domxref('PeriodicSyncManager')}}.

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

js-nolint
addEventListener("periodicsync", (event) => { })

onperiodicsync = (event) => { }

Event type

A {{domxref("PeriodicSyncEvent")}}. Inherits from {{domxref("Event")}}.

{{InheritanceDiagram("PeriodicSyncEvent")}}

Event properties

Inherits properties from its ancestor, {{domxref("Event")}}.

  • {{domxref('PeriodicSyncEvent.tag')}} {{ReadOnlyInline}}
    • : Returns the developer-defined identifier for this PeriodicSyncEvent. Multiple tags can be used by the web app to run different periodic tasks at different frequencies.

Examples

The following example shows how to respond to a periodic sync event in the service worker.

js
self.addEventListener("periodicsync", (event) => {
  if (event.tag === "get-latest-news") {
    event.waitUntil(fetchAndCacheLatestNews());
  }
});

You can also set up the event handler using the onperiodicsync property:

js
self.onperiodicsync = (event) => {
  // …
};

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also