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.module_type_desc -> Parsetree.module_type
  val attr :
    Parsetree.module_type -> Parsetree.attribute -> Parsetree.module_type
  val ident :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.module_type
  val alias :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.module_type
  val signature :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs -> Parsetree.signature -> Parsetree.module_type
  val functor_ :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    Ast_helper.str ->
    Parsetree.module_type option ->
    Parsetree.module_type -> Parsetree.module_type
  val with_ :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs ->
    Parsetree.module_type ->
    Parsetree.with_constraint list -> Parsetree.module_type
  val typeof_ :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs -> Parsetree.module_expr -> Parsetree.module_type
  val extension :
    ?loc:Ast_helper.loc ->
    ?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.module_type
end