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 'a t
  exception Empty
  val create : unit -> 'a Queue.t
  val add : 'a -> 'a Queue.t -> unit
  val push : 'a -> 'a Queue.t -> unit
  val take : 'a Queue.t -> 'a
  val pop : 'a Queue.t -> 'a
  val peek : 'a Queue.t -> 'a
  val top : 'a Queue.t -> 'a
  val clear : 'a Queue.t -> unit
  val copy : 'a Queue.t -> 'a Queue.t
  val is_empty : 'a Queue.t -> bool
  val length : 'a Queue.t -> int
  val iter : ('a -> unit) -> 'a Queue.t -> unit
  val fold : ('b -> 'a -> 'b) -> 'b -> 'a Queue.t -> 'b
  val transfer : 'a Queue.t -> 'a Queue.t -> unit
end