Clients: matchAll() 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.

Hinweis: Diese Funktion ist nur in Service Workers verfügbar.

Die matchAll()-Methode der Clients-Schnittstelle gibt ein Promise für eine Liste von Service Worker-Client-Objekten zurück. Schließen Sie den options-Parameter ein, um alle Service Worker-Clients zurückzugeben, deren Ursprung derselbe ist wie der Ursprung des zugehörigen Service Workers. Wenn keine Optionen eingeschlossen sind, gibt die Methode nur die vom Service Worker kontrollierten Service Worker-Clients zurück.

Syntax

js
matchAll()
matchAll(options)

Parameter

options Optional

Ein Optionsobjekt, mit dem Sie Optionen für den Matching-Vorgang festlegen können. Verfügbare Optionen sind:

includeUncontrolled

Ein boolescher Wert — wenn auf true gesetzt, wird der Matching-Vorgang alle Service Worker-Clients zurückgeben, die denselben Ursprung wie der aktuelle Service Worker teilen. Andernfalls werden nur die Service Worker-Clients zurückgegeben, die vom aktuellen Service Worker kontrolliert werden. Der Standardwert ist false.

type

Legt den Typ der Clients fest, die Sie abgleichen möchten. Verfügbare Werte sind "window", "worker", "sharedworker" und "all". Der Standardwert ist "window".

Rückgabewert

Ein Promise, das zu einem Array von Client-Objekten auflöst. In Chrome 46/Firefox 54 und später gibt diese Methode Clients in der Reihenfolge der zuletzt fokussierten, korrekt gemäß Spezifikation, zurück.

Beispiele

js
clients.matchAll(options).then((clientList) => {
  for (const client of clientList) {
    if (client.url === "index.html") {
      clients.openWindow(client);
      // or do something else involving the matching client
    }
  }
});

Spezifikationen

Specification
Service Workers
# clients-matchall

Browser-Kompatibilität