package brr

  1. Overview
  2. Docs
package brr
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Service_worker.ClientsSource

Clients objects.

Sourcetype query_opts

The type for query options.

Sourceval query_opts : ?include_uncontrolled:bool -> ?type':Client.Type.t -> unit -> query_opts

query_opts ~include_uncontrolled ~type' () are query options with the given properties.

Sourcetype t

The type for Clients objects.

Sourceval get : t -> Jstr.t -> Client.t option Fut.or_error

get cs id is a client matching id (if any).

Sourceval match_all : ?query_opts:query_opts -> t -> Client.t list Fut.or_error

match_all cs ~query_opts are clients matching query_opts.

Sourceval open_window : t -> Jstr.t -> Client.Window.t option Fut.or_error

open_window cs uri opens a window on uri.

Sourceval claim : t -> unit Fut.or_error

claim cs sets the calling service worker as a controller for all clients in its scope.