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 mk :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    Parsetree.core_type_desc -> Parsetree.core_type
  val attr :
    Parsetree.core_type -> Parsetree.attribute -> Parsetree.core_type
  val any :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs -> unit -> Parsetree.core_type
  val var :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs -> string -> Parsetree.core_type
  val arrow :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    Asttypes.label ->
    Parsetree.core_type -> Parsetree.core_type -> Parsetree.core_type
  val tuple :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    Parsetree.core_type list -> Parsetree.core_type
  val constr :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    Ast_helper.lid -> Parsetree.core_type list -> Parsetree.core_type
  val object_ :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    (string * Parsetree.attributes * Parsetree.core_type) list ->
    Asttypes.closed_flag -> Parsetree.core_type
  val class_ :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    Ast_helper.lid -> Parsetree.core_type list -> Parsetree.core_type
  val alias :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    Parsetree.core_type -> string -> Parsetree.core_type
  val variant :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    Parsetree.row_field list ->
    Asttypes.closed_flag -> Asttypes.label list option -> Parsetree.core_type
  val poly :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    string list -> Parsetree.core_type -> Parsetree.core_type
  val package :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    Ast_helper.lid ->
    (Ast_helper.lid * Parsetree.core_type) list -> Parsetree.core_type
  val extension :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.core_type
  val force_poly : Parsetree.core_type -> Parsetree.core_type
end