Module `Js_of_ocaml.Js`Source

Javascript binding

This module provides types and functions to interoperate with Javascript values, and gives access to Javascript standard objects.

Dealing with `null` and `undefined` values.

Sourcetype +'a opt

Type of possibly null values.

Sourcetype +'a optdef

Type of possibly undefined values.

Sourceval null : 'a Js_of_ocaml.Js.opt

The null value.

Sourceval some : 'a -> 'a Js_of_ocaml.Js.opt

Consider a value into a possibly null value.

Sourceval undefined : 'a Js_of_ocaml.Js.optdef

The undefined value

Sourceval def : 'a -> 'a Js_of_ocaml.Js.optdef

Consider a value into a possibly undefined value.

Sourcemodule type OPT = sig ... end

Signatures of a set of standard functions for manipulating optional values.

Sourcemodule Opt : Js_of_ocaml.Js.OPT with type 'a t = 'a Js_of_ocaml.Js.opt

Standard functions for manipulating possibly null values.

Sourcemodule Optdef : Js_of_ocaml.Js.OPT with type 'a t = 'a Js_of_ocaml.Js.optdef

Standard functions for manipulating possibly undefined values.

Types for specifying method and properties of Javascript objects

Sourcetype +'a t

Type of Javascript objects. The type parameter is used to specify more precisely an object.

Sourcetype +'a meth

Type used to specify method types: a Javascript object <m : t1 -> t2 -> ... -> tn -> t Js.meth> Js.t has a Javascript method m expecting n arguments of types t1 to tn and returns a value of type t.

Sourcetype +'a gen_prop

Type used to specify the properties of Javascript objects. In practice you should rarely need this type directly, but should rather use the type abbreviations below instead.

Sourcetype 'a readonly_prop = < get : 'a > Js_of_ocaml.Js.gen_prop

Type of read-only properties: a Javascript object <p : t Js.readonly_prop> Js.t has a read-only property p of type t.

Sourcetype 'a writeonly_prop = < set : 'a -> unit > Js_of_ocaml.Js.gen_prop

Type of write-only properties: a Javascript object <p : t Js.writeonly_prop> Js.t has a write-only property p of type t.

Sourcetype 'a prop = < get : 'a ; set : 'a -> unit > Js_of_ocaml.Js.gen_prop

Type of read/write properties: a Javascript object <p : t Js.writeonly_prop> Js.t has a read/write property p of type t.

Source

type 'a optdef_prop =
  < get : 'a Js_of_ocaml.Js.optdef ; set : 'a -> unit > Js_of_ocaml.Js.gen_prop

Type of read/write properties that may be undefined: you can set them to a value of some type t, but if you read them, you will get a value of type t optdef (that may be undefined).

Object constructors

Sourcetype +'a constr

A value of type (t1 -> ... -> tn -> t Js.t) Js.constr is a Javascript constructor expecting n arguments of types t1 to tn and returning a Javascript object of type t Js.t. Use the syntax extension new%js c e1 ... en to build an object using constructor c and arguments e1 to en.

Callbacks to OCaml

Sourcetype (-'a, +'b) meth_callback

Type of callback functions. A function of type (u, t1 -> ... -> tn -> t) meth_callback can be called from Javascript with this bound to a value of type u and up to n arguments of types t1 to tn. The system takes care of currification, so less than n arguments can be provided. As a special case, a callback of type (t, unit -> t) meth_callback can be called from Javascript with no argument. It will behave as if it was called with a single argument of type unit.

Sourcetype 'a callback = (unit, 'a) Js_of_ocaml.Js.meth_callback

Type of callback functions intended to be called without a meaningful this implicit parameter.

Sourceval wrap_callback : ('a -> 'b) -> ('c, 'a -> 'b) Js_of_ocaml.Js.meth_callback

Wrap an OCaml function so that it can be invoked from Javascript.

Sourceval wrap_meth_callback : ('b -> 'a) -> ('b, 'a) Js_of_ocaml.Js.meth_callback

Wrap an OCaml function so that it can be invoked from Javascript. The first parameter of the function will be bound to the value of the this implicit parameter.

Javascript comparisons

Sourceval equals : _ Js_of_ocaml.Js.t -> _ Js_of_ocaml.Js.t -> bool

Javascript == equality operator.

Sourceval strict_equals : _ Js_of_ocaml.Js.t -> _ Js_of_ocaml.Js.t -> bool

Javascript === equality operator.

Javascript standard objects

Sourceval _true : bool Js_of_ocaml.Js.t

Javascript true boolean.

Sourceval _false : bool Js_of_ocaml.Js.t

Javascript false boolean.

Sourcetype match_result_handle

A handle to a match result. Use function Js.match_result to get the corresponding MatchResult object. (This type is used to resolved the mutual dependency between string and array type definitions.)

Sourcetype string_array

Opaque type for string arrays. You can get the actual Array object using function Js.str_array. (This type is used to resolved the mutual dependency between string and array type definitions.)

Sourcetype normalization

Opaque type for Unicode normalization forms.

Sourceval nfd : Js_of_ocaml.Js.normalization Js_of_ocaml.Js.t

Canonical Decomposition

Sourceval nfc : Js_of_ocaml.Js.normalization Js_of_ocaml.Js.t

Canonical Decomposition, followed by Canonical Composition

Sourceval nfkd : Js_of_ocaml.Js.normalization Js_of_ocaml.Js.t

Compatibility Decomposition

Sourceval nfkc : Js_of_ocaml.Js.normalization Js_of_ocaml.Js.t

Compatibility Decomposition, followed by Canonical Composition

Specification of Javascript number objects.

Sourceclass type number = object ... end

Sourceclass type js_string = object ... end

Specification of Javascript string objects.

Sourceclass type regExp = object ... end

Specification of Javascript regular expression objects.

Sourcetype number_t = number Js_of_ocaml.Js.t

Sourceclass type string_constr = object ... end

Specification of the string constructor, considered as an object.

Sourceval string_constr : string_constr Js_of_ocaml.Js.t

The string constructor, as an object.

Source

val regExp : 
  (js_string Js_of_ocaml.Js.t -> regExp Js_of_ocaml.Js.t) Js_of_ocaml.Js.constr

Constructor of RegExp objects. The expression new%js regExp s builds the regular expression specified by string s.

Source

val regExp_withFlags : 
  (js_string Js_of_ocaml.Js.t ->
    js_string Js_of_ocaml.Js.t ->
    regExp Js_of_ocaml.Js.t)
    Js_of_ocaml.Js.constr

Constructor of RegExp objects. The expression new%js regExp s f builds the regular expression specified by string s using flags f.

Source

val regExp_copy : 
  (regExp Js_of_ocaml.Js.t -> regExp Js_of_ocaml.Js.t) Js_of_ocaml.Js.constr

Constructor of RegExp objects. The expression new%js regExp r builds a copy of regular expression r.

Sourceclass type 'a js_array = object ... end

Specification of Javascript regular arrays. Use Js.array_get and Js.array_set to access and set array elements.

Source

val object_keys : 
  'a Js_of_ocaml.Js.t ->
  js_string Js_of_ocaml.Js.t js_array Js_of_ocaml.Js.t

Returns jsarray containing keys of the object as Object.keys does.

Sourceval array_empty : 'a js_array Js_of_ocaml.Js.t Js_of_ocaml.Js.constr

Constructor of Array objects. The expression new%js array_empty returns an empty array.

Sourceval array_length : (int -> 'a js_array Js_of_ocaml.Js.t) Js_of_ocaml.Js.constr

Constructor of Array objects. The expression new%js array_length l returns an array of length l.

Sourceval array_get : 'a js_array Js_of_ocaml.Js.t -> int -> 'a Js_of_ocaml.Js.optdef

Array access: array_get a i returns the element at index i of array a. Returns undefined if there is no element at this index.

Sourceval array_set : 'a js_array Js_of_ocaml.Js.t -> int -> 'a -> unit

Array update: array_set a i v puts v at index i in array a.

Source

val array_map : 
  ('a -> 'b) ->
  'a js_array Js_of_ocaml.Js.t ->
  'b js_array Js_of_ocaml.Js.t

Array map: array_map f a is a##map(wrap_callback (fun elt idx arr -> f elt)).

Source

val array_mapi : 
  (int -> 'a -> 'b) ->
  'a js_array Js_of_ocaml.Js.t ->
  'b js_array Js_of_ocaml.Js.t

Array mapi: array_mapi f a is a##map(wrap_callback (fun elt idx arr -> f idx elt)).

Sourceclass type match_result = object ... end

Specification of match result objects

Source

val str_array : 
  Js_of_ocaml.Js.string_array Js_of_ocaml.Js.t ->
  js_string Js_of_ocaml.Js.t js_array Js_of_ocaml.Js.t

Convert an opaque string_array t object into an array of string. (Used to resolved the mutual dependency between string and array type definitions.)

Source

val match_result : 
  Js_of_ocaml.Js.match_result_handle Js_of_ocaml.Js.t ->
  match_result Js_of_ocaml.Js.t

Convert a match result handle into a MatchResult object. (Used to resolved the mutual dependency between string and array type definitions.)

Sourceclass type date = object ... end

Specification of Javascript date objects.

Sourceval date_now : date Js_of_ocaml.Js.t Js_of_ocaml.Js.constr

Constructor of Date objects: new%js date_now returns a Date object initialized with the current date.

Source

val date_fromTimeValue : 
  (Js_of_ocaml.Js.number_t -> date Js_of_ocaml.Js.t) Js_of_ocaml.Js.constr

Constructor of Date objects: new%js date_fromTimeValue t returns a Date object initialized with the time value t.

Sourceval date_month : (int -> int -> date Js_of_ocaml.Js.t) Js_of_ocaml.Js.constr

Constructor of Date objects: new%js date_fromTimeValue y m returns a Date object corresponding to year y and month m.

Source

val date_day : 
  (int -> int -> int -> date Js_of_ocaml.Js.t) Js_of_ocaml.Js.constr

Constructor of Date objects: new%js date_fromTimeValue y m d returns a Date object corresponding to year y, month m and day d.

Source

val date_hour : 
  (int -> int -> int -> int -> date Js_of_ocaml.Js.t) Js_of_ocaml.Js.constr

Constructor of Date objects: new%js date_fromTimeValue y m d h returns a Date object corresponding to year y to hour h.

Source

val date_min : 
  (int ->
    int ->
    int ->
    int ->
    int ->
    date Js_of_ocaml.Js.t)
    Js_of_ocaml.Js.constr

Constructor of Date objects: new%js date_fromTimeValue y m d h m' returns a Date object corresponding to year y to minute m'.

Source

val date_sec : 
  (int ->
    int ->
    int ->
    int ->
    int ->
    int ->
    date Js_of_ocaml.Js.t)
    Js_of_ocaml.Js.constr

Constructor of Date objects: new%js date_fromTimeValue y m d h m' s returns a Date object corresponding to year y to second s.

Source

val date_ms : 
  (int ->
    int ->
    int ->
    int ->
    int ->
    int ->
    int ->
    date Js_of_ocaml.Js.t)
    Js_of_ocaml.Js.constr

Constructor of Date objects: new%js date_fromTimeValue y m d h m' s ms returns a Date object corresponding to year y to millisecond ms.

Sourceclass type date_constr = object ... end

Specification of the date constructor, considered as an object.

Sourceval date : date_constr Js_of_ocaml.Js.t

The date constructor, as an object.

Sourceclass type math = object ... end

Specification of Javascript math object.

Sourceval math : math Js_of_ocaml.Js.t

The Math object

Sourceclass type error = object ... end

Specification of Javascript error object.

Source

val error_constr : 
  (js_string Js_of_ocaml.Js.t -> error Js_of_ocaml.Js.t) Js_of_ocaml.Js.constr

Constructor of Error objects: new%js error_constr msg returns an Error object with the message msg.

Sourcemodule Js_error : sig ... end

Sourceclass type json = object ... end

Specification of Javascript JSON object.

Sourceval _JSON : json Js_of_ocaml.Js.t

JSON object

Standard Javascript functions

Sourceval decodeURI : js_string Js_of_ocaml.Js.t -> js_string Js_of_ocaml.Js.t

Decode a URI: replace by the corresponding byte all escape sequences but the ones corresponding to a URI reserved character and convert the string from UTF-8 to UTF-16.

Source

val decodeURIComponent : 
  js_string Js_of_ocaml.Js.t ->
  js_string Js_of_ocaml.Js.t

Decode a URIComponent: replace all escape sequences by the corresponding byte and convert the string from UTF-8 to UTF-16.

Sourceval encodeURI : js_string Js_of_ocaml.Js.t -> js_string Js_of_ocaml.Js.t

Encode a URI: convert the string to UTF-8 and replace all unsafe bytes by the corresponding escape sequence.

Source

val encodeURIComponent : 
  js_string Js_of_ocaml.Js.t ->
  js_string Js_of_ocaml.Js.t

Same as encodeURI, but also encode URI reserved characters.

Sourceval escape : js_string Js_of_ocaml.Js.t -> js_string Js_of_ocaml.Js.t

Escape a string: unsafe UTF-16 code points are replaced by 2-digit and 4-digit escape sequences.

Sourceval unescape : js_string Js_of_ocaml.Js.t -> js_string Js_of_ocaml.Js.t

Unescape a string: 2-digit and 4-digit escape sequences are replaced by the corresponding UTF-16 code point.

Sourceval isNaN : 'a -> bool

Sourceval parseInt : js_string Js_of_ocaml.Js.t -> int

Sourceval parseFloat : js_string Js_of_ocaml.Js.t -> Js_of_ocaml.Js.number_t

Conversion functions between Javascript and OCaml types

Sourceval bool : bool -> bool Js_of_ocaml.Js.t

Conversion of booleans from OCaml to Javascript.

Sourceval to_bool : bool Js_of_ocaml.Js.t -> bool

Conversion of booleans from Javascript to OCaml.

Sourceval string : string -> js_string Js_of_ocaml.Js.t

Conversion of strings from OCaml to Javascript. (The OCaml string is considered to be encoded in UTF-8 and is converted to UTF-16.)

Sourceval to_string : js_string Js_of_ocaml.Js.t -> string

Conversion of strings from Javascript to OCaml.

Sourceval array : 'a array -> 'a js_array Js_of_ocaml.Js.t

Conversion of arrays from OCaml to Javascript.

Sourceval to_array : 'a js_array Js_of_ocaml.Js.t -> 'a array

Conversion of arrays from Javascript to OCaml.

Sourceval bytestring : string -> js_string Js_of_ocaml.Js.t

Conversion of strings of bytes from OCaml to Javascript. (Each byte will be converted in an UTF-16 code point.)

Sourceval to_bytestring : js_string Js_of_ocaml.Js.t -> string

Conversion of strings of bytes from Javascript to OCaml. (The Javascript string should only contain UTF-16 code points below 255.)

Sourceval float : float -> Js_of_ocaml.Js.number_t

Conversion of OCaml floats to Javascript numbers.

Sourceval to_float : Js_of_ocaml.Js.number_t -> float

Conversion of Javascript numbers to OCaml floats.

Sourceval number_of_float : float -> number Js_of_ocaml.Js.t

Conversion of OCaml floats to Javascript number objects.

Sourceval float_of_number : number Js_of_ocaml.Js.t -> float

Conversion of Javascript number objects to OCaml floats.

Sourceval int32 : int32 -> Js_of_ocaml.Js.number_t

Conversion of OCaml floats to Javascript numbers.

Sourceval to_int32 : Js_of_ocaml.Js.number_t -> int32

Conversion of Javascript numbers to OCaml 32-bits. The given floating-point number is truncated to an integer.

Sourceval nativeint : nativeint -> Js_of_ocaml.Js.number_t

Conversion of OCaml 32-bits integers to Javascript numbers.

Sourceval to_nativeint : Js_of_ocaml.Js.number_t -> nativeint

Conversion of Javascript numbers to OCaml native integers. The given floating-point number is truncated to an integer.

Convenience coercion functions

Sourceval coerce : 'a -> ('a -> 'b Js_of_ocaml.Js.Opt.t) -> ('a -> 'b) -> 'b

Apply a possibly failing coercion function. coerce v c f attempts to apply coercion c to value v. If the coercion returns null, function f is called.

Source

val coerce_opt : 
  'a Js_of_ocaml.Js.Opt.t ->
  ('a -> 'b Js_of_ocaml.Js.Opt.t) ->
  ('a -> 'b) ->
  'b

Apply a possibly failing coercion function. coerce_opt v c f attempts to apply coercion c to value v. If v is null or the coercion returns null, function f is called. Typical usage is the following:

Js.coerce_opt (Dom_html.document##getElementById id)
Dom_html.CoerceTo.div (fun _ -> assert false)

Type checking operators.

Sourceval typeof : _ Js_of_ocaml.Js.t -> js_string Js_of_ocaml.Js.t

Returns the type of a Javascript object.

Sourceval instanceof : _ Js_of_ocaml.Js.t -> _ Js_of_ocaml.Js.constr -> bool

Tests whether a Javascript object is an instance of a given class.

Debugging operations.

Sourceval debugger : unit -> unit

Invokes any available debugging functionality. If no debugging functionality is available, it has no effect. In practice, it will insert a "debugger;" statement in the generated javascript.

Export functionality.

Export values to module.exports if it exists or to the global object otherwise.

Sourceval export : string -> 'a -> unit

export name value export name

Sourceval export_all : 'a Js_of_ocaml.Js.t -> unit

export_all obj export every key of obj object.

export_all
  object%js
    method add x y = x +. y
    method abs x = abs_float x
    val zero = 0.
  end

Unsafe operations.

Sourcemodule Unsafe : sig ... end

Unsafe Javascript operations

Deprecated functions and types.

Sourceval string_of_error : error Js_of_ocaml.Js.t -> string

deprecated [since 4.0] Use [Js_error.to_string] instead.

Sourceval raise_js_error : error Js_of_ocaml.Js.t -> 'a

deprecated [since 4.0] Use [Js_error.raise_] instead.

Sourceval exn_with_js_backtrace : exn -> force:bool -> exn

Attach a JavasScript error to an OCaml exception. if force = false and a JavasScript error is already attached, it will do nothing. This function is useful to store and retrieve information about JavaScript stack traces.

Attaching JavasScript errors will happen automatically when compiling with --enable with-js-error.

deprecated [since 4.0] Use [Js_error.raise_] instead.

Sourceval js_error_of_exn : exn -> error Js_of_ocaml.Js.t Js_of_ocaml.Js.opt

Extract a JavaScript error attached to an OCaml exception, if any. This is useful to inspect an eventual stack strace, especially when sourcemap is enabled.

deprecated [since 4.0] Use [Js_error.of_exn] instead.

Sourceexception Error of error Js_of_ocaml.Js.t

The Error exception wrap javascript exceptions when caught by OCaml code. In case the javascript exception is not an instance of javascript Error, it will be serialized and wrapped into a Failure exception.

deprecated [since 4.0] Use [Js_error.Exn] instead.

Sourcetype float_prop = Js_of_ocaml.Js.number_t Js_of_ocaml.Js.prop

deprecated [since 2.0].

Type of float properties.

Module Js_of_ocaml.JsSource

Dealing with null and undefined values.

Types for specifying method and properties of Javascript objects

Object constructors

Callbacks to OCaml

Javascript comparisons

Javascript standard objects

Standard Javascript functions

Conversion functions between Javascript and OCaml types

Convenience coercion functions

Type checking operators.

Debugging operations.

Export functionality.

Unsafe operations.

Deprecated functions and types.

Module `Js_of_ocaml.Js`Source

Dealing with `null` and `undefined` values.