This is the event type for fetch events dispatched on the service worker global scope. It contains information about the fetch, including the request and how the receiver will treat the response. It provides the event.respondWith() method, which allows us to provide a response to this fetch.
On this page
FetchEvent
Constructor
-
FetchEvent() -
Creates a new
FetchEventobject. This constructor is not typically used. The browser creates these objects and provides them tofetchevent callbacks.
Instance properties
Inherits properties from its ancestor, Event.
FetchEvent.clientIdRead onlyFetchEvent.handledRead only-
A promise that is pending while the event has not been handled, and fulfilled once it has.
FetchEvent.preloadResponseRead only-
A
Promisefor aResponse, orundefinedif this fetch is not a navigation, or navigation preload is not enabled. FetchEvent.replacesClientIdRead only-
The
idof theclientthat is being replaced during a page navigation. FetchEvent.resultingClientIdRead only-
The
idof theclientthat replaces the previous client during a page navigation. FetchEvent.requestRead only-
The
Requestthe browser intends to make.
Instance methods
Inherits methods from its parent, ExtendableEvent.
-
FetchEvent.respondWith() -
Prevent the browser's default fetch handling, and provide (a promise for) a response yourself.
-
ExtendableEvent.waitUntil() -
Extends the lifetime of the event. Used to notify the browser of tasks that extend beyond the returning of a response, such as streaming and caching.
Examples
This fetch event uses the browser default for non-GET requests. For GET requests it tries to return a match in the cache, and falls back to the network. If it finds a match in the cache, it asynchronously updates the cache for next time.
js
self.addEventListener("fetch", (event) => {
// Let the browser do its default thing
// for non-GET requests.
if (event.request.method !== "GET") return;
// Prevent the default, and handle the request ourselves.
event.respondWith(
(async () => {
// Try to get the response from a cache.
const cache = await caches.open("dynamic-v1");
const cachedResponse = await cache.match(event.request);
if (cachedResponse) {
// If we found a match in the cache, return it, but also
// update the entry in the cache in the background.
event.waitUntil(cache.add(event.request));
return cachedResponse;
}
// If we didn't find a match in the cache, use the network.
return fetch(event.request);
})(),
);
});
Specifications
| Specification |
|---|
| Service Workers # fetchevent-interface |
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
FetchEvent |
44 | 17 | 44 | No | 31 | 11.1 | 44 | 44 | 44 | 32 | 11.3 | 4.0 |
FetchEvent |
40 | 17 | 44 | No | 27 | 11.1 | 40 | 40 | 44 | 27 | 11.3 | 4.0 |
clientId |
49 | 17 | 45 | No | 36 | 11.1 | 49 | 49 | 45 | 36 | 11.3 | 5.0 |
handled |
86 | 86 | 84 | No | 72 | 16 | 86 | 86 | 84 | 61 | 16 | 14.0 |
isReload |
40May be removed in a future release, see bug 652994. |
17 | 44–74 | No | 27 | No | 40 |
40May be removed in a future release, see bug 652994. |
44–79 | 27 | No | 4.0 |
preloadResponse |
59 | 18 | 99 | No | 46 | 15.4 | 59 | 59 | 99 | 43 | 15.4 | 7.0 |
replacesClientId |
No | No | No | No | No | 11.1–16 | No | No | No | No | 11.3–16 | No |
request |
40 | 17 | 44 | No | 27 | 11.1 | 40 | 40 | 44 | 27 | 11.3 | 4.0 |
respondWith |
42 | 17 | 44 | No | 29 | 11.1 | 42 | 42 | 44 | 29 | 11.3 | 4.0 |
resultingClientId |
72 | 79 | 65 | No | 60 | 16 | 72 | 72 | 65 | 50 | 16 | 11.0 |
See also
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/FetchEvent