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 Failure
  exception Error of string
  val from : (int -> 'a option) -> 'a Stream.t
  val of_list : 'a list -> 'a Stream.t
  val of_string : string -> char Stream.t
  val of_bytes : bytes -> char Stream.t
  val of_channel : Pervasives.in_channel -> char Stream.t
  val iter : ('a -> unit) -> 'a Stream.t -> unit
  val next : 'a Stream.t -> 'a
  val empty : 'a Stream.t -> unit
  val peek : 'a Stream.t -> 'a option
  val junk : 'a Stream.t -> unit
  val count : 'a Stream.t -> int
  val npeek : int -> 'a Stream.t -> 'a list
  val iapp : 'a Stream.t -> 'a Stream.t -> 'a Stream.t
  val icons : 'a -> 'a Stream.t -> 'a Stream.t
  val ising : 'a -> 'a Stream.t
  val lapp : (unit -> 'a Stream.t) -> 'a Stream.t -> 'a Stream.t
  val lcons : (unit -> 'a) -> 'a Stream.t -> 'a Stream.t
  val lsing : (unit -> 'a) -> 'a Stream.t
  val sempty : 'a Stream.t
  val slazy : (unit -> 'a Stream.t) -> 'a Stream.t
  val dump : ('a -> unit) -> 'a Stream.t -> unit
end