Cache.delete()

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

cache.delete(request, {options}).then(function(found) {
  // your cache entry has been deleted if found
});

Parameters

request

The Request you are looking to delete. This can be a Request 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 of http://foo.com/?value=bar would be ignored when performing a match. It defaults to false.
  • ignoreMethod: A boolean value that, when set to true, prevents matching operations from validating the Request HTTP method (normally only GET and HEAD are allowed.) It defaults to false.
  • ignoreVary: A boolean value that, when set to true, tells the matching operation not to perform VARY header matching.  In other words, if the URL matches you will get a match regardless of  whether the Response object has a VARY header. It defaults to false.
  • cacheName: A DOMString 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(function(cache) {
  cache.delete('/images/image.png').then(function(response) {
    someUIUpdateFunction();
  });
})

Specifications

Specification
Service Workers 1
# cache-delete

Browser compatibility

BCD tables only load in the browser

See also