Cache: put() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("Service Workers API")}}{{SecureContext_Header}}{{AvailableInWorkers}}
The **put()** method of the {{domxref("Cache")}} interface allows key/value pairs to be added to the current {{domxref("Cache")}} object.
Often, you will just want to {{domxref("Window/fetch", "fetch()")}} one or more requests, then add the result straight to your cache. In such cases you are better off using {{domxref("Cache.add","Cache.add()")}}/{{domxref("Cache.addAll","Cache.addAll()")}}, as they are shorthand functions for one or more of these operations.
fetch(url).then((response) => {
if (!response.ok) {
throw new TypeError("Bad response status");
}
return cache.put(url, response);
});توجه: put() will overwrite any key/value pair previously stored in the cache that matches the request.
توجه: {{domxref("Cache.add")}}/{{domxref("Cache.addAll")}} do not cache responses with Response.status values that are not in the 200 range, whereas Cache.put lets you store any request/response pair. As a result, {{domxref("Cache.add")}}/{{domxref("Cache.addAll")}} can't be used to store opaque responses, whereas Cache.put can.
Syntax
put(request, response)Parameters
request- : The {{domxref("Request")}} object or URL that you want to add to the cache.
response- : The {{domxref("Response")}} you want to match up to the request.
Return value
A {{jsxref("Promise")}} that resolves with undefined.
Exceptions
- {{jsxref("TypeError")}}
- : Returned if the URL scheme is not
httporhttps.
Examples
This example is from the MDN simple-service-worker example (see simple-service-worker running live). Here we wait for a {{domxref("FetchEvent")}} to fire. We construct a custom response like so:
- Check whether a match for the request is found in the {{domxref("CacheStorage")}}
using {{domxref("CacheStorage.match","CacheStorage.match()")}}. If so, serve that.
- If not, open the
v1cache usingopen(), put the default
network request in the cache using Cache.put() and return a clone of the default network request using return response.clone(). Clone is needed because put() consumes the response body.
- If this fails (e.g., because the network is down), return a fallback response.
let response;
const cachedResponse = caches
.match(event.request)
.then((r) => (r !== undefined ? r : fetch(event.request)))
.then((r) => {
response = r;
caches.open("v1").then((cache) => cache.put(event.request, response));
return response.clone();
})
.catch(() => caches.match("/gallery/myLittleVader.jpg"));Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- Using Service Workers
- {{domxref("Cache")}}
- {{domxref("Window.caches")}} and {{domxref("WorkerGlobalScope.caches")}}