package brr

  1. Overview
  2. Docs
Browser programming toolkit for OCaml

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC; BSD-3-Clause License Edit opam file Versions (3)

Authors

  1. T
    The brr programmers

Maintainers

  1. Daniel Bünzli

Sources

brr-0.0.9.tbz
sha512=45cdf73c6a23c8fc4609a32ae2196d4790e5bdba34ca0b784bff9c0b70dab233eb336f1c11dc3002451042ff4cf25b643098ad0d011f14c3d6175842113bed21

doc/brr/Brr_webworkers/Worker/index.html

Module Brr_webworkers.WorkerSource

Web workers.

See the Web Workers API.

Enumerations

Sourcemodule Type : sig ... end

The worker type enum.

Workers

Sourcetype opts

The type for worker options.

Sourceval opts : ?type':Type.t -> ?credentials:Brr_io.Fetch.Request.Credentials.t -> ?name:Jstr.t -> unit -> opts

opts ~type' ~credentials ~name () are worker options with given parameters. See here for defaults and semantics.

Sourcetype t

The type for Worker objects.

Sourceval create : ?opts:opts -> Jstr.t -> t

create ~opts uri creates a worker that executes the script uri. This may throw a Jv.Error exception.

Sourceval as_target : t -> Brr.Ev.target

as_target w is w as an event target.

Sourceval terminate : t -> unit

terminate w terminates worker w.

Sourceval post : ?opts:Brr_io.Message.opts -> t -> 'a -> unit

post ~opts w v posts value v on port p with options opts (the target_origin option is meaningless in this case).

Shared workers

Sourcemodule Shared : sig ... end

Shared workers.

Worker context

These APIs are used by the workers.

Sourceval ami : unit -> bool

ami () is true if we are executing in a worker context.

Sourcemodule G : sig ... end

Worker global functions