BackgroundFetchEvent

Limited availability

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

Experimental:This is anexperimental technology
Check theBrowser compatibility table carefully before using this in production.

Note: This feature is only available inService Workers.

TheBackgroundFetchEvent interface of theBackground Fetch API is the event type for background fetch events dispatched on theservice worker global scope.

It is the event type passed tobackgroundfetchclick event andbackgroundfetchabort event.

Constructor

BackgroundFetchEvent()Experimental: Creates a newBackgroundFetchEvent 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.registrationRead onlyExperimental: Returns the BackgroundFetchRegistration that the event was initialized to.

Instance methods

Also inherits methods from its parent,ExtendableEvent.

None.

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

addEventListener("backgroundfetchclick", (event) => {  const bgFetch = event.registration;  if (bgFetch.result === "success") {    clients.openWindow("/latest-podcasts");  } else {    clients.openWindow("/download-progress");  }});