Cache: keys() Methode

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2018.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die keys() Methode der Cache Schnittstelle gibt ein Promise zurück, das in ein Array von Request Objekten aufgelöst wird. Diese Objekte repräsentieren die Schlüssel des Cache.

Die Anfragen werden in der gleichen Reihenfolge zurückgegeben, in der sie eingefügt wurden.

Hinweis: Anfragen mit doppelten URLs, aber unterschiedlichen Headern können zurückgegeben werden, wenn ihre Antworten den VARY Header gesetzt haben.

Syntax

keys()
keys(request)
keys(request, options)

Parameter

request Optional

Der gewünschte Request, falls ein spezifischer Schlüssel gewünscht ist. Dies kann ein Request Objekt oder eine URL sein.

options Optional

Ein Objekt, dessen Eigenschaften kontrollieren, wie das Matching bei der keys Operation durchgeführt wird. Die verfügbaren Optionen sind:

ignoreSearch: Ein boolescher Wert, der angibt, ob der Abgleichsprozess den Query-String in der URL ignorieren soll. Wenn auf true gesetzt, würde der ?value=bar Teil von http://foo.com/?value=bar beim Abgleich ignoriert werden. Standardmäßig ist dieser Wert false.
ignoreMethod: Ein boolescher Wert, der, wenn auf true gesetzt, verhindert, dass Abgleichsoperationen die HTTP Methode des Request validieren (normalerweise sind nur GET und HEAD erlaubt). Standardmäßig ist dieser Wert false.
ignoreVary: Ein boolescher Wert, der, wenn auf true gesetzt, angibt, dass die Abgleichsoperation kein VARY Header-Matching durchführen soll. Mit anderen Worten, wenn die URL übereinstimmt, erhalten Sie eine Übereinstimmung, unabhängig davon, ob das Response Objekt einen VARY Header hat. Standardmäßig ist dieser Wert false.
cacheName: Ein String, der einen spezifischen Cache darstellt, in dem gesucht werden soll. Beachten Sie, dass diese Option von Cache.keys() ignoriert wird.

Rückgabewert

Ein Promise, das in ein Array von Request Objekten aufgelöst wird.

Beispiele

caches
  .open("v1")
  .then((cache) => cache.keys())
  .then((keys) => {
    keys.forEach((request, index, array) => {
      cache.delete(request);
    });
  });

Spezifikationen

Specification
Service Workers # cache-keys