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 ->
    Parsetree.structure_item_desc -> Parsetree.structure_item
  val eval :
    ?loc:Ast_helper.loc ->
    ?attrs:Parsetree.attributes ->
    Parsetree.expression -> Parsetree.structure_item
  val value :
    ?loc:Ast_helper.loc ->
    Asttypes.rec_flag ->
    Parsetree.value_binding list -> Parsetree.structure_item
  val primitive :
    ?loc:Ast_helper.loc ->
    Parsetree.value_description -> Parsetree.structure_item
  val type_ :
    ?loc:Ast_helper.loc ->
    Parsetree.type_declaration list -> Parsetree.structure_item
  val type_extension :
    ?loc:Ast_helper.loc ->
    Parsetree.type_extension -> Parsetree.structure_item
  val exception_ :
    ?loc:Ast_helper.loc ->
    Parsetree.extension_constructor -> Parsetree.structure_item
  val module_ :
    ?loc:Ast_helper.loc ->
    Parsetree.module_binding -> Parsetree.structure_item
  val rec_module :
    ?loc:Ast_helper.loc ->
    Parsetree.module_binding list -> Parsetree.structure_item
  val modtype :
    ?loc:Ast_helper.loc ->
    Parsetree.module_type_declaration -> Parsetree.structure_item
  val open_ :
    ?loc:Ast_helper.loc ->
    Parsetree.open_description -> Parsetree.structure_item
  val class_ :
    ?loc:Ast_helper.loc ->
    Parsetree.class_declaration list -> Parsetree.structure_item
  val class_type :
    ?loc:Ast_helper.loc ->
    Parsetree.class_type_declaration list -> Parsetree.structure_item
  val include_ :
    ?loc:Ast_helper.loc ->
    Parsetree.include_declaration -> Parsetree.structure_item
  val extension :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    Parsetree.extension -> Parsetree.structure_item
  val attribute :
    ?loc:Ast_helper.loc -> Parsetree.attribute -> Parsetree.structure_item
  val text : Docstrings.text -> Parsetree.structure_item list
end