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

  val argv : string array
  val executable_name : string
  external file_exists : string -> bool = "caml_sys_file_exists"
  external is_directory : string -> bool = "caml_sys_is_directory"
  external remove : string -> unit = "caml_sys_remove"
  external rename : string -> string -> unit = "caml_sys_rename"
  external getenv : string -> string = "caml_sys_getenv"
  external command : string -> int = "caml_sys_system_command"
  external time : unit -> float = "caml_sys_time"
  external chdir : string -> unit = "caml_sys_chdir"
  external getcwd : unit -> string = "caml_sys_getcwd"
  external readdir : string -> string array = "caml_sys_read_directory"
  val interactive : bool Pervasives.ref
  val os_type : string
  val unix : bool
  val win32 : bool
  val cygwin : bool
  val word_size : int
  val big_endian : bool
  val max_string_length : int
  val max_array_length : int
  type signal_behavior =
      Signal_default
    | Signal_ignore
    | Signal_handle of (int -> unit)
  external signal : int -> Sys.signal_behavior -> Sys.signal_behavior
    = "caml_install_signal_handler"
  val set_signal : int -> Sys.signal_behavior -> unit
  val sigabrt : int
  val sigalrm : int
  val sigfpe : int
  val sighup : int
  val sigill : int
  val sigint : int
  val sigkill : int
  val sigpipe : int
  val sigquit : int
  val sigsegv : int
  val sigterm : int
  val sigusr1 : int
  val sigusr2 : int
  val sigchld : int
  val sigcont : int
  val sigstop : int
  val sigtstp : int
  val sigttin : int
  val sigttou : int
  val sigvtalrm : int
  val sigprof : int
  exception Break
  val catch_break : bool -> unit
  val ocaml_version : string
end