Js.Json
Provide utilities for json
Efficient JSON encoding using JavaScript API
type tagged_t =
| JSONFalse
| JSONTrue
| JSONNull
| JSONString of string
| JSONNumber of float
| JSONArray of t array
val test : 'a -> 'b kind -> bool
test v kind
returns true if v
is of kind
val decodeString : t -> string option
decodeString json
returns Some s
if json
is a string, None
otherwise
val decodeNumber : t -> float option
decodeNumber json
returns Some n
if json
is a number, None
otherwise
decodeObject json
returns Some o
if json
is an object, None
otherwise
decodeArray json
returns Some a
if json
is an array, None
otherwise
val decodeBoolean : t -> bool option
decodeBoolean json
returns Some b
if json
is a boolean, None
otherwise
val decodeNull : t -> 'a Js__.Js_internal.null option
decodeNull json
returns Some null
if json
is a null, None
otherwise
Those functions allows the construction of an arbitrary complex JSON values.
val null : t
null
is the singleton null JSON value
val string : string -> t
string s
makes a JSON string of the string
s
val number : float -> t
number n
makes a JSON number of the float
n
val boolean : bool -> t
boolean b
makes a JSON boolean of the bool
b
The functions below are specialized for specific array type which happened to be already JSON object in the Melange runtime. Therefore they are more efficient (constant time rather than linear conversion).
val stringArray : string array -> t
stringArray a
makes a JSON array of the string array
a
val numberArray : float array -> t
numberArray a
makes a JSON array of the float array
a
val booleanArray : bool array -> t
booleanArray
makes a JSON array of the bool array
a
objectArray a
makes a JSON array of the JsDict.t array
a
val parseExn : string -> t
parseExn s
parses the string s
into a JSON data structure
Returns a JSON data structure
val stringify : t -> string
stringify json
formats the JSON data structure as a string
Returns the string representation of a given JSON data structure
(* Creates and stringifies a simple JS object *)
let dict = Js.Dict.empty () in
Js.Dict.set dict "name" (Js.Json.string "John Doe");
Js.Dict.set dict "age" (Js.Json.number 30.0);
Js.Dict.set dict "likes"
(Js.Json.stringArray [|"bucklescript";"ocaml";"js"|]);
Js.log (Js.Json.stringify (Js.Json.object_ dict))
val stringifyWithSpace : t -> int -> string
stringify json
formats the JSON data structure as a string
Returns the string representation of a given JSON data structure
(* Creates and stringifies a simple JS object with spacing *)
let dict = Js.Dict.empty () in
Js.Dict.set dict "name" (Js.Json.string "John Doe");
Js.Dict.set dict "age" (Js.Json.number 30.0);
Js.Dict.set dict "likes"
(Js.Json.stringArray [|"bucklescript";"ocaml";"js"|]);
Js.log (Js.Json.stringifyWithSpace (Js.Json.object_ dict) 2)
stringifyAny value
formats any value
into a JSON string
(* prints ``"foo", "bar"`` *)
Js.log (Js.Json.stringifyAny [| "foo"; "bar" |])
Best-effort serialization, it tries to seralize as many objects as possible and deserialize it back
It is unsafe in two aspects