package bonsai

You can search for identifiers within the package.

in-package search v0.2.0

A library for building dynamic webapps, using Js_of_ocaml

Install

Dune Dependency

github.com Readme MIT License Edit opam file Versions (6)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.15.1.tar.gz

sha256=0c4a714146073f421f1a6179561f836b45d8dc012c743207d3481ea63bef74bf

doc/bonsai.web/Bonsai_web/Persistent_var/index.html

Module `Bonsai_web.Persistent_var`Source

Sourcetype 'a t

Source

val create : 
  (module Core.Sexpable with type t = 'a) ->
  [ `Local_storage | `Session_storage ] ->
  unique_id:string ->
  default:'a ->
  'a t

A Persistent_var.t is similar to Bonsai.Var.t, but the contents of the var are persisted into either local storage or session storage.

Creating a persistent var requires that the type contained inside the var to be sexpable, so a first class module for the type should be passed in.

You have a choice between Local Storage and Session Storage for actually persisting things; The docs for which can be found here:

https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage
https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage

A unique_id is required for the storage. This value needs to be unique per application.

Finally, a fallback is required for when the value can't be found, or it can't be deserialized.

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

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

Sourceval get : 'a t -> 'a

Sourceval value : 'a t -> 'a Bonsai.Value.t

Sourceval clear_persistence : 'a t -> unit

This will remove the value from localstorage or sessionstorage. (calling set or update afterwards will still store the value back again.)

Sourceval effect : 'a t -> 'a -> unit Effect.t

By asking for the vars effect, you get a function that can be easily threaded through your components and triggered inside an action-application or inside of an event listener.