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 extern_flags = No_sharing | Closures | Compat_32
  val to_channel :
    Pervasives.out_channel -> 'a -> Marshal.extern_flags list -> unit
  external to_bytes : 'a -> Marshal.extern_flags list -> bytes
    = "caml_output_value_to_string"
  external to_string : 'a -> Marshal.extern_flags list -> string
    = "caml_output_value_to_string"
  val to_buffer :
    bytes -> int -> int -> 'a -> Marshal.extern_flags list -> int
  val from_channel : Pervasives.in_channel -> 'a
  val from_bytes : bytes -> int -> 'a
  val from_string : string -> int -> 'a
  val header_size : int
  val data_size : bytes -> int -> int
  val total_size : bytes -> int -> int
end