Module `Brr_io.Storage`

Storage objects.

type t

The type for Storage objects.

val local : Brr.Window.t -> Brr_io.Storage.t

local w is the storage saved accross page sessions for the window's origin.

val session : Brr.Window.t -> Brr_io.Storage.t

session w is the storage cleared when the page session ends for the window's origin.

val length : Brr_io.Storage.t -> int

length s is the number of items in s.

val key : Brr_io.Storage.t -> int -> Jstr.t option

key s i is the name of the ith key. (N.B. local storage can race with other tabs)

val get_item : Brr_io.Storage.t -> Jstr.t -> Jstr.t option

get_item s k is the value of k in s.

val set_item : 
  Brr_io.Storage.t ->
  Jstr.t ->
  Jstr.t ->
  (unit, Jv.Error.t) Stdlib.result

set_item s k v sets the value of k to v in s. An error is returned if the value could not be set (no permission or quota exceeded).

val remove_item : Brr_io.Storage.t -> Jstr.t -> unit

remove_item s k removes the value of k from s. If k has no value this does nothing.

val clear : Brr_io.Storage.t -> unit

clear s removes all keys from s.

Events

module Ev : sig ... end

Storage event.

val to_jv : Brr_io.Storage.t -> Jv.jv

val of_jv : Jv.jv -> Brr_io.Storage.t