Clients

Types

clientQueryOptions

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

Record fields

includeUncontrolled

option< bool >

type_

option< string >

Values

claim

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

let claim: ServiceWorkerTypes.clients => promise<unit>

Parameters

ServiceWorkerTypes.clients

Return type

promise< unit >

get

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

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

Parameters

ServiceWorkerTypes.clients string

Return type

promise< Stdlib.Nullable.t< ServiceWorkerTypes.client > >

matchAll

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

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

Parameters

ServiceWorkerTypes.clients option< clientQueryOptions >

Return type

promise< array< ServiceWorkerTypes.client > >

openWindow

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

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

Parameters

ServiceWorkerTypes.clients string

Return type

promise< ServiceWorkerTypes.windowClient >