package jenga

  1. Overview
  2. Docs
package jenga
Legend:
Library
Module
Module type
Parameter
Class
Class type

A table of registered environment variables, with typed access

type 'a t

Var.t is a typed environment variable

val sexp_of_t : ('a -> Ppx_sexp_conv_lib.Sexp.t) -> 'a t -> Ppx_sexp_conv_lib.Sexp.t

It is an error to register a name more than once, unless it has been unregistered by unregister name or clear_all_registrations

val register : ?choices:string list -> string -> string option t
val register_with_default : ?choices:string list -> string -> default:string -> string t
val clear_all_registrations : unit -> unit

Clears the set of known vars, but if variable by the same name are recreated later, the relevant setenv will still be in effect.

val unregister : string -> unit
val registered_names : unit -> string list
val is_registered : string -> bool
module Info : sig ... end
val change_to_peeked_var : unit Tenacious.t
val all_registered : unit -> Info.t list
val peek : ?dont_trigger:unit -> 'a t -> 'a
val watch : 'a t -> 'a Core.Or_error.t Tenacious.t
val map : 'a t -> f:('a -> 'b) -> 'b t
module Getenv : sig ... end
module Setenv : sig ... end
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