ServiceWorkerGlobalScope: sync event
The sync event of the ServiceWorkerGlobalScope interface is fired when the page (or worker) that registered the event with the SyncManager is running and as soon as network connectivity is available.
This event is not cancelable and does not bubble.
Syntax
Use the event name in methods like addEventListener(), or set an event handler property.
addEventListener('sync', event => { });
onsync = event => { };
Event type
Event properties
Inherits properties from its ancestor, Event.
SyncEvent.tagRead only-
Returns the developer-defined identifier for this
SyncEvent. SyncEvent.lastChanceRead only-
Returns
trueif the user agent will not make further synchronization attempts after the current attempt.
Examples
The following example shows how to respond to a sync event in the service worker.
self.addEventListener('sync', event => {
if (event.tag == 'sync-messages') {
event.waitUntil(sendOutboxMessages());
}
});
You can also set up the event handler using the onsync property:
self.onsync = event => {
...
};
Specifications
| Specification |
|---|
| Web Background Synchronization # sync-event |
Browser compatibility
BCD tables only load in the browser