ContentIndex: delete() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Note: This feature is available in Web Workers.
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
delete(id)
Parameters
id
-
The unique identifier of the indexed content you want the
ContentIndex
object to remove.
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
BCD tables only load in the browser