We're looking for a user researcher to understand the needs of developers and designers. Is this you or someone you know? Check out the post: https://mzl.la/2IGzdXS

Clients.matchAll()

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The matchAll() method of the Clients interface returns a Promise for a list of service worker Client objects. Include the options parameter to return all service worker clients whose origin is the same as the associated service worker's origin. If options are not included, the method returns only the service worker clients controlled by the service worker.

Syntax

ServiceWorkerClients.matchAll(options).then(function(clients) {
  // do something with your clients list
});

Parameters

options Optional
An options object allowing you to set options for the matching operation. Available options are:
  • includeUncontrolled: A Boolean — if set to true, the matching operation will return all service worker clients who share the same origin as the current service worker. Otherwise, it returns only the service worker clients controlled by the current service worker. The default is false.
  • type: Sets the type of clients you want matched. Available values are window, worker, sharedworker, and all. The default is all.

Return value

Promise that resolves to an array of Client objects. In Chrome 46/Firefox 54 and later, this method returns clients in most recently focused order, correct as per spec.

Examples

clients.matchAll(options).then(function(clientList) {
  for (var i = 0 ; i < clients.length ; i++) {
    if (clientList[i].url === 'index.html') {
      clients.openWindow(clientList[i]);
      // or do something else involving the matching client
    }
  }
});

Specifications

Specification Status Comment
Service Workers
The definition of 'Clients' in that specification.
Working Draft Initial definition

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support471 ?

442

541

No32 No
includeUncontrolled option471 ?453 No38 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support471471 ?

44

541

32 No4.0
includeUncontrolled option471471 ?45338 No5.0

1. Client objects returned in most recent focus order.

2. Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).

3. includeUncontrolled support.

Document Tags and Contributors

Last updated by: fscholz,