BackgroundFetchEvent

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The BackgroundFetchEvent interface of the Background Fetch API is the event type for background fetch events dispatched on the service worker global scope.

It is the event type passed to backgroundfetchclick event and backgroundfetchabort event.

Event ExtendableEvent BackgroundFetchEvent

Constructor

BackgroundFetchEvent()

Creates a new BackgroundFetchEvent object. This constructor is not typically used, as the browser creates these objects itself and provides them to background fetch event callbacks.

Instance properties

Also inherits properties from its parent, ExtendableEvent.

BackgroundFetchEvent.registration Read only

Returns the BackgroundFetchRegistration that the event was initialized to.

Instance methods

Also inherits methods from its parent, ExtendableEvent.

None.

Examples

In this example, if the user clicks on the user interface displaying the download progress, a new window will open. The current BackgroundFetchRegistration is returned by calling event.registration.

js
addEventListener("backgroundfetchclick", (event) => {
  const bgFetch = event.registration;

  if (bgFetch.result === "success") {
    clients.openWindow("/latest-podcasts");
  } else {
    clients.openWindow("/download-progress");
  }
});

Specifications

Specification
Background Fetch
# background-fetch-event

Browser compatibility

BCD tables only load in the browser