ServiceWorkerGlobalScope: periodicsync event
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The periodicsync
event of the ServiceWorkerGlobalScope
interface is fired at timed intervals, specified when registering a PeriodicSyncManager
.
This event is not cancelable and does not bubble.
Syntax
Use the event name in methods like addEventListener()
, or set an event handler property.
js
addEventListener("periodicsync", (event) => {});
onperiodicsync = (event) => {};
Event type
A PeriodicSyncEvent
. Inherits from Event
.
Event properties
Inherits properties from its ancestor, Event
.
PeriodicSyncEvent.tag
Read only-
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
Specification |
---|
Web Periodic Background Synchronization # periodicsync-event |
Web Periodic Background Synchronization # dom-serviceworkerglobalscope-onperiodicsync |
Browser compatibility
BCD tables only load in the browser