ContentIndex.delete()
Draft: This page is not complete.
The delete()
method of the ContentIndex
interface unregisters an item from the currently indexed content.
Note: Calling delete()
only affects the index. It does not delete anything from the Cache
.
Syntax
ContentIndex.delete(id).then(...);
Parameters
This method receives no parameters.
Return value
Returns a Promise
that resolves with undefined
Exceptions
No exceptions are thrown.
Examples
Below is an asynchronous function, that removes an item from the content index
. We receive a reference to the current ServiceWorkerRegistration
, which allows us to access the index
property and thus access the delete
method.
async function unregisterContent(article) { // reference registration const registration = await navigator.serviceWorker.ready; // feature detect Content Index if (!registration.index) return; // unregister content from index await registration.index.delete(article.id); }
The delete
method can also be used within the service worker
scope.
self.registration.index.delete('my-id');
Specifications
Specification |
---|
Content Index # content-index-delete |
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 | |
delete |
No |
No |
No |
No |
No |
No |
84 |
84 |
No |
60 |
No |
14.0 |
See also
- An introductory article on the Content Index API
- An app which uses the Content Index API to list and remove 'save for later' content
- Service Worker API, along with information about Cache and CacheStorage
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ContentIndex/delete