API reference

The Js_of_ocaml distribution ships several opam packages, each providing one or more libraries. This page lists the public modules of every package; see the documentation home for the manual.

The top-level module of each library also states, in its own documentation, which opam package provides it.

js_of_ocaml — the base library

Provided by the js_of_ocaml opam package (library js_of_ocaml).

Core runtime and JavaScript values:

• Js_of_ocaml.Js Javascript binding
• Js_of_ocaml.Js_error
• Js_of_ocaml.Jstable A minimal table implementation specialized for Js.js_string keys. This is faster than regular OCaml hashtables.
• Js_of_ocaml.Sys_js Javascript specific Sys functions.
• Js_of_ocaml.Typed_array Typed Array binding
• Js_of_ocaml.Effect_js Javascript-specific effect functions.

Browser APIs:

• Js_of_ocaml.Abort AbortController / AbortSignal.
• Js_of_ocaml.CSS This module contains a few types and values to ease the use of CSS properties and such. If you think a feature is missing, consider sending a patch or an RFE to the mailing list.
• Js_of_ocaml.Cache Cache API: persistent storage of Fetch Request/Response pairs.
• Js_of_ocaml.Clipboard Clipboard API.
• Js_of_ocaml.Console Console API (debugging console).
• Js_of_ocaml.Crypto Web Crypto API.
• Js_of_ocaml.Dom DOM binding
• Js_of_ocaml.Dom_events Javascript events
• Js_of_ocaml.Dom_html DOM HTML binding
• Js_of_ocaml.Dom_svg DOM SVG binding
• Js_of_ocaml.EventSource EventSource binding
• Js_of_ocaml.Fetch Fetch API.
• Js_of_ocaml.File File API
• Js_of_ocaml.FontFace CSS Font Loading API binding.
• Js_of_ocaml.Form
• Js_of_ocaml.Geolocation Geolocation API
• Js_of_ocaml.IntersectionObserver The Intersection Observer API provides a way to asynchronously observe changes in the intersection of a target element with an ancestor element or with a top-level document's viewport.
• Js_of_ocaml.Intl Internationalization API
• Js_of_ocaml.Json Unsafe IO. (See Deriving_Json for typesafe IO)
• Js_of_ocaml.MessageChannel Channel messaging: MessageChannel, MessagePort and MessageEvent.
• Js_of_ocaml.MutationObserver MutationObserver API
• Js_of_ocaml.Notification Notifications API.
• Js_of_ocaml.Performance Performance API
• Js_of_ocaml.PerformanceObserver PerformanceObserver API
• Js_of_ocaml.Promise Bindings to the JavaScript Promise API.
• Js_of_ocaml.Regexp Types for regexps.
• Js_of_ocaml.ResizeObserver ResizeObserver API
• Js_of_ocaml.ServiceWorker Service Workers.
• Js_of_ocaml.Url This module provides functions for tampering with Url. It's main goal is to allow one to stay in the Ocaml realm without wandering into the Dom_html.window##.location object.
• Js_of_ocaml.WebGL WebGL binding
• Js_of_ocaml.WebGL2 WebGL2 binding.
• Js_of_ocaml.WebSockets WebSocket binding
• Js_of_ocaml.Worker Low-level bindgins to javascript Web Workers.
• Js_of_ocaml.XmlHttpRequest XmlHttpRequest object.

The same opam package also provides the js_of_ocaml.deriving library — the runtime used by the code that [@@deriving json] generates:

• Deriving_Json Typesafe IO (based on the deriving library).
• Deriving_Json_lexer

and the js_of_ocaml.devtools library, which displays OCaml values in the browser developer tools when the compiler is built with Introcaml:

• Js_of_ocaml_devtools Browser developer tools integration (library js_of_ocaml.devtools).

js_of_ocaml-lwt — Lwt support

Provided by the js_of_ocaml-lwt opam package (library js_of_ocaml-lwt).

• Js_of_ocaml_lwt.Lwt_js — sleeping and yielding
• Js_of_ocaml_lwt.Lwt_js_events — DOM events as Lwt threads
• Js_of_ocaml_lwt.XmlHttpRequest — XMLHttpRequest with Lwt
• Js_of_ocaml_lwt.Jsonp — JSONP requests
• Js_of_ocaml_lwt.File — reading files with Lwt
• Js_of_ocaml_lwt.Promise — bridge between Lwt threads and JS promises

js_of_ocaml-ppx_deriving_json — JSON derivation syntax

Provided by the js_of_ocaml-ppx_deriving_json opam package. This is the PPX that derives JSON serializers ([@@deriving json]); the generated code relies on the Deriving_Json runtime from the js_of_ocaml package above. See the manual for usage.

js_of_ocaml-tyxml — TyXML support

Provided by the js_of_ocaml-tyxml opam package (library js_of_ocaml-tyxml).

• Js_of_ocaml_tyxml.Tyxml_js — build and manipulate DOM trees with TyXML
• Js_of_ocaml_tyxml.Tyxml_cast — cast between TyXML and Dom nodes
• Js_of_ocaml_tyxml.Tyxml_cast_sigs — signatures for the casts

js_of_ocaml-toplevel — toplevel and Dynlink

Provided by the js_of_ocaml-toplevel opam package (library js_of_ocaml-toplevel).

• Js_of_ocaml_toplevel.Direct — run an OCaml toplevel in the browser
• Js_of_ocaml_toplevel.Wrapped — toplevel evaluation returning errors and warnings as first-class values
• Js_of_ocaml_toplevel.Wrapped_intf — result, error and warning types shared with the Web Worker driver