OCaml JavaScript Standard ML TypeScript Makefile HTML Other
Clone or download
hhugo Merge pull request #685 from jjurm/master
Lib: fix DataTransfer class interface
Latest commit d31eecb Jul 30, 2018
Failed to load latest commit information.
benchmarks Clean: remove Array.create Sep 5, 2014
camlp4 Camlp4: clean pa_deriving Feb 10, 2018
compiler Misc: fix for 407 Jun 6, 2018
doc Revert "Remove lwt-logger" Jul 9, 2018
examples Build: upgrade to jbuilder beta17 Feb 7, 2018
lib Lib: fix DataTransfer class interface Jul 30, 2018
ocamlbuild Doc: ocamlbuild Apr 15, 2017
ppx Misc: fix test Mar 27, 2018
runtime Runtime: bigstring_destroy_stub (part 2) Jul 10, 2018
tools Tests:remove more warning Feb 7, 2018
toplevel Toplevel: fix toplevel Apr 7, 2018
.gitignore Misc: Switch to jbuilder Mar 29, 2017
.jenkins.sh Misc Apr 30, 2017
.ocp-indent Update .ocp-indent Sep 4, 2014
.travis.yml Misc: setup travis Jan 23, 2018
CHANGES Misc: prepare 3.2.1 Jul 26, 2018
LICENSE Misc: headers Apr 15, 2017
META.js_of_ocaml-camlp4.template META: restore meta for camlp4 Feb 11, 2018
META.js_of_ocaml-compiler.template runtime: always include weak.js Jan 9, 2018
META.js_of_ocaml-ppx.template Missing "=" in Meta file Dec 4, 2017
META.js_of_ocaml-toplevel.template Misc: Switch to jbuilder Mar 29, 2017
META.js_of_ocaml.template Misc: cleanup after revert Jul 9, 2018
Makefile Misc: more cleanup Feb 11, 2018
Makefile.conf Toplevel: fix build of the toplevel example Nov 4, 2017
README.md misc: restore toplevel Jul 9, 2018
TODO.txt Lib: DomContentLoaded Jul 25, 2014
VERSION Misc: prepare 3.2.1 Jul 26, 2018
appveyor.yml Misc Apr 30, 2017
jbuild Build: upgrade to jbuilder beta17 Feb 7, 2018
jbuild-workspace.dev configure workspace Nov 12, 2017
js_of_ocaml-camlp4.opam Build: upgrade to jbuilder beta17 Feb 7, 2018
js_of_ocaml-compiler.opam Build: upgrade to jbuilder beta17 Feb 7, 2018
js_of_ocaml-lwt.opam js_of_ocaml-lwt: add optional dependency on lwt_log Jul 24, 2018
js_of_ocaml-ocamlbuild.opam Build: upgrade to jbuilder beta17 Feb 7, 2018
js_of_ocaml-ppx.opam Build: upgrade to jbuilder beta17 Feb 7, 2018
js_of_ocaml-ppx_deriving_json.opam Build: upgrade to jbuilder beta17 Feb 7, 2018
js_of_ocaml-toplevel.opam Build: upgrade to jbuilder beta17 Feb 7, 2018
js_of_ocaml-tyxml.opam Build: upgrade to jbuilder beta17 Feb 7, 2018
js_of_ocaml.opam Build: upgrade to jbuilder beta17 Feb 7, 2018


Build Status

Js_of_ocaml (jsoo)

Js_of_ocaml is a compiler from OCaml bytecode to JavaScript. It makes it possible to run pure OCaml programs in JavaScript environment like browsers and Node.js.

  • It is easy to install and use as it works with an existing installation of OCaml, with no need to recompile any library.
  • It comes with bindings for a large part of the browser APIs.
  • According to our benchmarks, the generated programs runs typically faster than with the OCaml bytecode interpreter.
  • We believe this compiler will prove much easier to maintain than a retargeted OCaml compiler, as the bytecode provides a very stable API.


Findlib, cppo See opam file for version constraints.


Toplevel requirements

  • base64, tyxml, reactiveData
  • ocp-indent: needed to support indentation in the toplevel
  • higlo: needed to support Syntax highlighting in the toplevel
  • cohttp: needed to build the toplevel webserver



opam install js_of_ocaml js_of_ocaml-ppx


  • edit Makefile.conf to change the default configuration
  • run make all to compile
  • run make install as root to install the compiler and its libraries
  • run make uninstall as root to uninstall them

You can run make toplevel-examples if you want to build a Web-based OCaml toplevel as well. Try the toplevel


Your program must first be compiled using the OCaml bytecode compiler ocamlc. JavaScript bindings are provided by the js_of_ocaml package. The syntax extension is provided by js_of_ocaml.syntax package.

ocamlfind ocamlc -package js_of_ocaml -package js_of_ocaml.ppx -linkpkg -o cubes.byte cubes.ml

Then, run the js_of_ocaml compiler to produce JavaScript code:

js_of_ocaml cubes.byte


Most of the OCaml standard library is supported. However,

  • Weak semantic cannot be implemented using JavaScript. A dummy implementation is provided.
  • Most of the Sys module is not supported.

Extra libraries distributed with Ocaml (such as Thread or Str) are not supported in general. However,

  • Bigarray: bigarrays are supported using Typed Arrays
  • Num: supported using +nat.js option
  • Graphics: partially supported using canvas (see js_of_ocaml.graphics)
  • Unix: time related functions are supported

Tail call is not optimized in general. However, mutually recursive functions are optimized:

  • self recursive functions (when the tail calls are the function itself) are compiled using a loop.
  • trampolines are used otherwise. More about tail call optimization.

Data representation differs from the usual one. Most notably, integers are 32 bits (rather than 31 bits or 63 bits), which is their natural size in JavaScript, and floats are not boxed. As a consequence, marshalling, polymorphic comparison, and hashing functions can yield results different from usual:

  • marshalling of floats is not supported (unmarshalling works);
  • the polymorphic hash function will not give the same results on datastructures containing floats;
  • these functions may be more prone to stack overflow.


Contents of the distribution

Filename Description
LICENSE license and copyright notice
README this file
compiler/ compiler
examples/ small examples
lib/ library for interfacing with JavaScript APIs
ppx/ ppx syntax extensions
camlp4/ camlp4 syntax extensions
runtime/ runtime system
toplevel/ web-based OCaml toplevel
ocamlbuild/ ocamlbuild plugin for js_of_ocaml