Clients

Types

type clientQueryOptions = {
  mutable includeUncontrolled?: bool,
  mutable type_?: string,
}

option< bool >

option< string >

Allows an active service worker to set itself as the controller for all clients within its scope. Read more on MDN

let claim: WebAPI.ServiceWorkerAPI.clients => promise<unit>

promise< unit >

Returns a Promise for a Client matching a given id. Read more on MDN

let get: (
  WebAPI.ServiceWorkerAPI.clients,
  string,
) => promise<Nullable.t<WebAPI.ServiceWorkerAPI.client>>

promise< Stdlib.Nullable.t< WebAPI.ServiceWorkerAPI.client > >

Returns a Promise for an array of Client objects matching the given options. Read more on MDN

let matchAll: (
  WebAPI.ServiceWorkerAPI.clients,
  ~options: clientQueryOptions=?,
) => promise<array<WebAPI.ServiceWorkerAPI.client>>

Opens a new browser window for a given URL and returns a Promise for the new WindowClient. Read more on MDN

let openWindow: (
  WebAPI.ServiceWorkerAPI.clients,
  string,
) => promise<WebAPI.ServiceWorkerAPI.windowClient>