Clients.matchAll()

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.

Expérimental: Cette fonction est expérimentale
Puisque cette fonction est toujours en développement dans certains navigateurs, veuillez consulter le tableau de compatibilité pour les préfixes à utiliser selon les navigateurs.
Il convient de noter qu'une fonctionnalité expérimentale peut voir sa syntaxe ou son comportement modifié dans le futur en fonction des évolutions de la spécification.

La méthode matchAll() de l'interface Clients retourne une Promesse pour une liste de service worker clients. Inclure le paramètre options permet de retourner tous les services worker clients dont l'origine est la même que l'origine du service worker associé. Si options n'est pas inclus, la méthode retourne que le service worker client controllé par le service worker.

Syntaxe

js
ServiceWorkerClients.matchAll(options).then(function (clients) {
  // faire quelque chose avec la list de clients
});

Paramètres

options

L'objet option vous permet de définir les options pour l'opération. Les options disponibles sont :

  • includeUncontrolled: Un Boolean — défini à true, l'opération retournera tous les services worker clients qui sont de la même origine que le service worker courant. Sinon, elle ne retournera que le service worker client controllé par le service worker courant. La valeur par défaut est false.
  • type: Défini le type de client que vous voulez observer. Les types disponibles sont window, worker, sharedworker, et all. La valeur par défaut est all.

Valeur de retour

Une Promesse qui se résout avec un tableau d'objets Client.

Exemples

js
clients.matchAll(options).then(function (clientList) {
  for (var i = 0; i < clients.length; i++) {
    if (clientList[i].url === "index.html") {
      clients.openWindow(clientList[i]);
      // ou faire quelque chose avec le client
    }
  }
});

Spécifications

Specification
Service Workers
# clients-matchall

Compatibilité des navigateurs

BCD tables only load in the browser