fmlib_js 0.5.9 · OCaml Package

Generate javascript values from ocaml values.

type t

Type of a javascript value.

val null : t

The javascript value null.

val undefined : t

The javascript value undefined.

val int : int -> t

int i The integer i as a javascript value.

This function is the identity function, because int is represented in javascript as a number which is a 64 bit floating point value.

As long as we stay within ocaml code, 32 bit signed integer arithmetics is done.

val float : float -> t

float v The floating point value v as a javascript value.

This function is the identity function, because float is represented in javascript as a number which is a 64 bit floating point value.

val bool : bool -> t

bool b Convert the ocaml boolean value b into a javascript boolean value.

val string : string -> t

string s Convert the ocaml string s into a javascript string.

In ocaml a string is a sequence of bytes and in javascript a string is a sequence of utf16 code points.

val _object : (string * t) array -> t

_object [|name1, value1; name2, value2; ...|]

Make the javascript object {name1: value1, name2: value2, ...}.

val array : t array -> t

array arr Convert the ocaml array arr of javascript objects into the corresponding javascript array.

val function1 : (t -> t) -> t

function1 f Convert the ocaml function f of type t -> t into the corresponding javascript function.

No actual conversion is necessary, because ocaml functions are compiled to javascript functions.

However javascript cannot do currying i.e. partial application. In javascript the corresponding function can be called with zero or more arguments.

If there are arguments missing, then the function will be called with sufficient arguments filled up by undefined.

If more arguments are supplied, then the superfluous arguments are ignored.

val function2 : (t -> t -> t) -> t

function2 f See function1, just that here f is a two argument function.

val function3 : (t -> t -> t -> t) -> t

function3 f See function1, just that here f is a three argument function.

val stringify : t -> t option

stringify v convert the javascript value v to a json string. This possible only if the javascript value is one of:

val parse : t -> t option

parse v parse the javascript value (which must be a string) as a json value and converts it into the corresponding javascript object.

Precondition: v is a javascript string and a valid json string.

package fmlib_js