package bonsai

  1. Overview
  2. Docs
package bonsai
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 'a t

A Var.t is the primary method for making data obtained outside of Bonsai (maybe via an RPC) accessible inside a Bonsai application.

val create : 'a -> 'a t

Creates a new Var.t with an initial value.

val update : 'a t -> f:('a -> 'a) -> unit

Updates the value inside of t. f is given the previous value of t so that you can reuse parts of the value if applicable

val set : 'a t -> 'a -> unit

Sets the value inside of t.

val get : 'a t -> 'a

Gets the value inside of t.

val value : 'a t -> 'a Value.t

Provides read-only access to t by producing a Value.t which is used inside of a Bonsai computation.

val incr_var : 'a t -> 'a Ui_incr.Var.t

Retrieves the underlying 'a t Ui_incr.t var.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct