gen_js_api

Easy OCaml bindings for JavaScript libraries
README

Overview

gen_js_api aims at simplifying the creation of OCaml bindings for
JavaScript libraries. It must currently be used with the js_of_ocaml
compiler
, although other ways
to run OCaml code "against" JavaScript might be supported later with
the same binding definitions (for instance,
Bucklescript,
or direct embedding of a JS engine in a native OCaml application).

gen_js_api is based on the following ideas:

  • Authors of bindings write OCaml signatures for JavaScript libraries
    and the tool generates the actual binding code with a combination
    of implicit conventions and explicit annotations.

  • The generated binding code takes care of translating values between
    OCaml and JavaScript and of dealing with JavaScript calling
    conventions.

  • All syntactic processing is done by authors of bindings: the client
    code is normal OCaml code and does not depend on custom syntax nor
    on JS-specific types.

gen_js_api can be used in two complementary ways:

Examples

The repository contains some examples of OCaml bindings to JavaScript
libraries created with gen_js_api:

Documentation

Related projects

  • js_of_ocaml: The compiler
    and runtime system on which gen_js_api relies. (Note: gen_js_api
    doesn't depend on js_of_ocaml's OCaml library, nor on its language
    extension.)

  • goji: A DSL to describe OCaml
    bindings for JavaScript libraries.

  • DefinitelyMaybeTyped:
    A project to parse
    DefinitelyTyped
    interfaces and produce OCaml interfaces.

  • ReScript:
    Another compiler from OCaml to JavaScript, featuring the genType ppx for generating TS / Flow types and runtime converters.

About

gen_js_api has been created by LexiFi for porting a web application
from JavaScript to OCaml. The tool has been used in production since
2015.

This gen_js_api package is licensed by LexiFi under the terms of the
MIT license.

See see Changelog

Contact: alain.frisch@lexifi.com

Contributors:

  • Alain Frisch

  • Sebastien Briais

Install
Maintainers
Sources
v1.1.0.tar.gz
md5=263dbe269b1b23fa58d146d7874acec6
sha512=e12a6e864afb6cac6229b56906a121f35a97d280e7008abe796b7583be934575c2c58b7944c720fd4bfb0ae6def04a1ffd37c8c71026e72862eb237324b69fe6
Dependencies
odoc
with-doc
ojs
= "1.1.0"
conf-npm
with-test
ppxlib
with-test & < "0.26.0"
ppxlib
>= "0.22"
ocaml
>= "4.08"
dune
>= "2.7"
Reverse Dependencies