Cache: delete() method
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Web Workers.
The delete()
method of the Cache
interface finds the Cache
entry whose key is the request, and if found, deletes the Cache
entry and returns a Promise
that resolves to true
.
If no Cache
entry is found, it resolves to false
.
Syntax
delete(request)
delete(request, options)
Parameters
request
-
The
Request
you are looking to delete. This can be aRequest
object or a URL. options
Optional-
An object whose properties control how matching is done in the
delete
operation. The available options are:ignoreSearch
-
A boolean value that specifies whether the matching process should ignore the query string in the URL. If set to
true
, the?value=bar
part ofhttp://foo.com/?value=bar
would be ignored when performing a match. It defaults tofalse
. ignoreMethod
-
A boolean value that, when set to
true
, prevents matching operations from validating theRequest
HTTP
method (normally onlyGET
andHEAD
are allowed.) It defaults tofalse
. ignoreVary
-
A boolean value that, when set to
true
, tells the matching operation not to performVARY
header matching. In other words, if the URL matches you will get a match regardless of whether theResponse
object has aVARY
header. It defaults tofalse
. cacheName
-
A string that represents a specific cache to search within. Note that this option is ignored by
Cache.delete()
.
Return value
a Promise
that resolves to true
if the cache entry is
deleted, or false
otherwise.
Examples
caches.open("v1").then((cache) => {
cache.delete("/images/image.png").then((response) => {
someUIUpdateFunction();
});
});
Specifications
Specification |
---|
Service Workers # cache-delete |
Browser compatibility
BCD tables only load in the browser