Quick StartTryGuideAPICommunityBlogGitHub

Standard Library

Below is the API for the OCaml standard library. It's directly copied over from the OCaml Manual, formatted to the Reason syntax and styled accordingly. The API docs are work-in-progress; we'll be polishing these gradually!

If you're targeting JavaScript, the API docs for BuckleScript includes all of below, plus JS-specific APIs.

sig

  type key
  type 'a t
  val create : int -> 'a Hashtbl.S.t
  val clear : 'a Hashtbl.S.t -> unit
  val reset : 'a Hashtbl.S.t -> unit
  val copy : 'a Hashtbl.S.t -> 'a Hashtbl.S.t
  val add : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a -> unit
  val remove : 'a Hashtbl.S.t -> Hashtbl.S.key -> unit
  val find : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a
  val find_all : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a list
  val replace : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a -> unit
  val mem : 'a Hashtbl.S.t -> Hashtbl.S.key -> bool
  val iter : (Hashtbl.S.key -> 'a -> unit) -> 'a Hashtbl.S.t -> unit
  val fold : (Hashtbl.S.key -> 'a -> 'b -> 'b) -> 'a Hashtbl.S.t -> 'b -> 'b
  val length : 'a Hashtbl.S.t -> int
  val stats : 'a Hashtbl.S.t -> Hashtbl.statistics
end