Firefox Tomorrow

web api event

ServiceWorkerGlobalScope: sync event

View on MDN ↗

Secure contextAvailable in workers

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

A SyncEvent. Inherits from ExtendableEvent and Event.

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

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.

See also