forked from rescript-lang/rescript
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathJs_json.html
457 lines (346 loc) · 21.3 KB
/
Js_json.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
<!doctype html>
<html>
<head>
<link rel="stylesheet" href="../api_static/tomorrow-night.css">
<link rel="stylesheet" href="../api_static/style.css" type="text/css">
<script src="../api_static//highlight.pack.js"></script>
<script src="../api_static//script.js"></script>
<script>hljs.initHighlightingOnLoad();</script><meta charset="utf-8">
<link rel="previous" href="Js_int64.html">
<link rel="next" href="Js_math.html">
<title>Js_json</title>
</head>
<body>
<nav class="module-index"><ul><li><a href="Bs.html">Bs</a></li>
<li><a href="Bs_dyn.html">Bs_dyn</a></li>
<li><a href="Bs_dyn_lib.html">Bs_dyn_lib</a></li>
<li><a href="Dom.html">Dom</a></li>
<li><a href="Js.html">Js</a></li>
<li><a href="Js_array.html">Js_array</a></li>
<li><a href="Js_boolean.html">Js_boolean</a></li>
<li><a href="Js_cast.html">Js_cast</a></li>
<li><a href="Js_date.html">Js_date</a></li>
<li><a href="Js_dict.html">Js_dict</a></li>
<li><a href="Js_exn.html">Js_exn</a></li>
<li><a href="Js_float.html">Js_float</a></li>
<li><a href="Js_global.html">Js_global</a></li>
<li><a href="Js_int.html">Js_int</a></li>
<li><a href="Js_int64.html">Js_int64</a></li>
<li><a href="Js_json.html">Js_json</a></li>
<li><a href="Js_math.html">Js_math</a></li>
<li><a href="Js_nativeint.html">Js_nativeint</a></li>
<li><a href="Js_null.html">Js_null</a></li>
<li><a href="Js_null_undefined.html">Js_null_undefined</a></li>
<li><a href="Js_obj.html">Js_obj</a></li>
<li><a href="Js_primitive.html">Js_primitive</a></li>
<li><a href="Js_promise.html">Js_promise</a></li>
<li><a href="Js_re.html">Js_re</a></li>
<li><a href="Js_string.html">Js_string</a></li>
<li><a href="Js_typed_array.html">Js_typed_array</a></li>
<li><a href="Js_types.html">Js_types</a></li>
<li><a href="Js_undefined.html">Js_undefined</a></li>
<li><a href="Js_unsafe.html">Js_unsafe</a></li>
<li><a href="Node.html">Node</a></li>
<li><a href="Node_buffer.html">Node_buffer</a></li>
<li><a href="Node_child_process.html">Node_child_process</a></li>
<li><a href="Node_fs.html">Node_fs</a></li>
<li><a href="Node_module.html">Node_module</a></li>
<li><a href="Node_path.html">Node_path</a></li>
<li><a href="Node_process.html">Node_process</a></li></ul></nav>
<div class="navbar"><a class="pre" href="Js_int64.html" title="Js_int64">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Js_math.html" title="Js_math">Next</a>
</div>
<h1>Module <a href="type_Js_json.html">Js_json</a></h1>
<pre><span class="keyword">module</span> Js_json: <code class="code">sig</code> <a href="Js_json.html">..</a> <code class="code">end</code></pre><div class="info module top">
<div class="not-examples">
Efficient JSON encoding using JavaScript API<br>
<div class="tag"><b>See also</b> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON">MDN</a><br>
</div>
</div>
<div class="examples">
</div>
</div>
<hr width="100%">
<div class="type-declaration">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
</div>
<div class="info ">
<div class="not-examples">
The JSON data structure<br>
</div>
<div class="examples">
</div>
</div>
<div class="type-declaration">
<pre><code><span id="TYPEkind"><span class="keyword">type</span> <code class="type">'_</code> kind</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.String"><span class="constructor">String</span></span></td><td><span class="keyword">:</span></td><td><code class="type"><a href="Js_string.html#TYPEt">Js_string.t</a> <a href="Js_json.html#TYPEkind">kind</a></code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Number"><span class="constructor">Number</span></span></td><td><span class="keyword">:</span></td><td><code class="type">float <a href="Js_json.html#TYPEkind">kind</a></code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Object"><span class="constructor">Object</span></span></td><td><span class="keyword">:</span></td><td><code class="type"><a href="Js_json.html#TYPEt">t</a> <a href="Js_dict.html#TYPEt">Js_dict.t</a> <a href="Js_json.html#TYPEkind">kind</a></code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Array"><span class="constructor">Array</span></span></td><td><span class="keyword">:</span></td><td><code class="type"><a href="Js_json.html#TYPEt">t</a> array <a href="Js_json.html#TYPEkind">kind</a></code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Boolean"><span class="constructor">Boolean</span></span></td><td><span class="keyword">:</span></td><td><code class="type"><a href="Js.html#TYPEboolean">Js.boolean</a> <a href="Js_json.html#TYPEkind">kind</a></code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Null"><span class="constructor">Null</span></span></td><td><span class="keyword">:</span></td><td><code class="type"><a href="Js_types.html#TYPEnull_val">Js_types.null_val</a> <a href="Js_json.html#TYPEkind">kind</a></code></code></td>
</tr></table>
</div>
<div class="info ">
<div class="not-examples">
Underlying type of a JSON value<br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALreifyType"><span class="keyword">val</span> reifyType</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> -> 'b <a href="Js_json.html#TYPEkind">kind</a> * 'b</code></pre><div class="info ">
<div class="not-examples">
<code class="code">reifyType v</code> returns both type and underlying value<br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALtest"><span class="keyword">val</span> test</span> : <code class="type">'a -> 'b <a href="Js_json.html#TYPEkind">kind</a> -> bool</code></pre><div class="info ">
<div class="not-examples">
<code class="code">test v kind</code> returns true if <code class="code">v</code> is of <code class="code">kind</code><br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALdecodeString"><span class="keyword">val</span> decodeString</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> -> <a href="Js_string.html#TYPEt">Js_string.t</a> option</code></pre><div class="info ">
<div class="not-examples">
<code class="code">decodeString json</code> returns <code class="code">Some s</code> if <code class="code">json</code> is a string, <code class="code">None</code>
otherwise<br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALdecodeNumber"><span class="keyword">val</span> decodeNumber</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> -> float option</code></pre><div class="info ">
<div class="not-examples">
<code class="code">decodeNumber json</code> returns <code class="code">Some n</code> if <code class="code">json</code> is a number, <code class="code">None</code>
otherwise<br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALdecodeObject"><span class="keyword">val</span> decodeObject</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> -> <a href="Js_json.html#TYPEt">t</a> <a href="Js_dict.html#TYPEt">Js_dict.t</a> option</code></pre><div class="info ">
<div class="not-examples">
<code class="code">decodeObject json</code> returns <code class="code">Some o</code> if <code class="code">json</code> is an object, <code class="code">None</code>
otherwise<br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALdecodeArray"><span class="keyword">val</span> decodeArray</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> -> <a href="Js_json.html#TYPEt">t</a> array option</code></pre><div class="info ">
<div class="not-examples">
<code class="code">decodeArray json</code> returns <code class="code">Some a</code> if <code class="code">json</code> is an array, <code class="code">None</code>
otherwise<br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALdecodeBoolean"><span class="keyword">val</span> decodeBoolean</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> -> <a href="Js.html#TYPEboolean">Js.boolean</a> option</code></pre><div class="info ">
<div class="not-examples">
<code class="code">decodeBoolean json</code> returns <code class="code">Some b</code> if <code class="code">json</code> is a boolean, <code class="code">None</code>
otherwise<br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALdecodeNull"><span class="keyword">val</span> decodeNull</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> -> 'a <a href="Js_null.html#TYPEt">Js_null.t</a> option</code></pre><div class="info ">
<div class="not-examples">
<code class="code">decodeNull json</code> returns <code class="code">Some null</code> if <code class="code">json</code> is a null, <code class="code">None</code>
otherwise<br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALnull"><span class="keyword">val</span> null</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">null</code> is the singleton null JSON value<br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALstring"><span class="keyword">val</span> string</span> : <code class="type">string -> <a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">string s</code> makes a JSON string of the <code class="code">string</code> <code class="code">s</code><br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALnumber"><span class="keyword">val</span> number</span> : <code class="type">float -> <a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">number n</code> makes a JSON number of the <code class="code">float</code> <code class="code">n</code><br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALboolean"><span class="keyword">val</span> boolean</span> : <code class="type"><a href="Js.html#TYPEboolean">Js.boolean</a> -> <a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">boolean b</code> makes a JSON boolean of the <code class="code">Js.boolean</code> <code class="code">b</code><br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALobject_"><span class="keyword">val</span> object_</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> <a href="Js_dict.html#TYPEt">Js_dict.t</a> -> <a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">object_ dict</code> makes a JSON objet of the <code class="code">Js.Dict.t</code> <code class="code">dict</code><br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALarray_"><span class="keyword">val</span> array_</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> array -> <a href="Js_json.html#TYPEt">t</a></code></pre>
<pre><span id="VALarray"><span class="keyword">val</span> array</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> array -> <a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">array_ a</code> makes a JSON array of the <code class="code">Js.Json.t array</code> <code class="code">a</code><br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALstringArray"><span class="keyword">val</span> stringArray</span> : <code class="type">string array -> <a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">stringArray a</code> makes a JSON array of the <code class="code">string array</code> <code class="code">a</code><br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALnumberArray"><span class="keyword">val</span> numberArray</span> : <code class="type">float array -> <a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">numberArray a</code> makes a JSON array of the <code class="code">float array</code> <code class="code">a</code><br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALbooleanArray"><span class="keyword">val</span> booleanArray</span> : <code class="type"><a href="Js.html#TYPEboolean">Js.boolean</a> array -> <a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">booleanArray</code> makes a JSON array of the <code class="code">Js.boolean array</code> <code class="code">a</code><br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALobjectArray"><span class="keyword">val</span> objectArray</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> <a href="Js_dict.html#TYPEt">Js_dict.t</a> array -> <a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">objectArray a</code> makes a JSON array of the <code class="code">JsDict.t array</code> <code class="code">a</code><br>
</div>
<div class="examples">
</div>
</div>
<pre><span id="VALparse"><span class="keyword">val</span> parse</span> : <code class="type">string -> <a href="Js_json.html#TYPEt">t</a></code></pre>
<pre><span id="VALparseExn"><span class="keyword">val</span> parseExn</span> : <code class="type">string -> <a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">parse s</code> parses the string <code class="code">s</code> into a JSON data structure
<p>
<b>Returns</b> a JSON data structure<br>
<div class="tag"><b>Raises</b> <code>SyntaxError</code> if given string is not a valid JSON. Note <code class="code">SyntaxError</code> is a JavaScript exception.<br>
</div><div class="tag"><b>See also</b> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse">MDN</a><br>
</div>
</div>
<div class="examples">
<pre class="example"><pre class="codepre"><code class="code">(* parse a simple JSON string *)
let json =
try
Js_json.parse {| "foo" |}
with
| _ -> failwith "Error parsing JSON string"
in
match Js.Json.reifyType json in
| (Js.Json.String, value) -> Js.log value
| _ -> failWith "Expected a string"
</code></pre></pre><pre class="example"><pre class="codepre"><code class="code">(* parse a complex JSON string *)
let getIds s =
let json =
try
Js.Json.parse s
with
| _ -> failwith "Error parsing JSON string"
in
match Js.Json.reifyType json with
| (Js.Json.Object, value) ->
(* In this branch, compiler infer value : Js.Json.t Js.Dict.t *)
begin match Js.Dict.get value "ids" with
| Some ids ->
begin match Js.Json.reifyType ids with
| (Js.Json.Array, ids) ->
(* In this branch compiler infer ids : Js.Json.t array *)
ids
| _ -> failWith "Expected an array"
end
| None -> failWith "Expected an `ids` property"
end
| _ -> failWith "Expected an object"
(* prints `1, 2, 3` *)
let _ =
Js.log @@ getIds {| { "ids" : [1, 2, 3 ] } |}
</code></pre></pre>
</div>
</div>
<pre><span id="VALstringify"><span class="keyword">val</span> stringify</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> -> string</code></pre><div class="info ">
<div class="not-examples">
<code class="code">stringify json</code> formats the JSON data structure as a string
<p>
<b>Returns</b> the string representation of a given JSON data structure<br>
<div class="tag"><b>See also</b> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">MDN</a><br>
</div>
</div>
<div class="examples">
<pre class="example"><pre class="codepre"><code class="code">(* 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.numberOfInt 30);
Js.Dict.set dict "likes"
(Js.Json.stringArray [|"bucklescript";"ocaml";"js"|]);
Js.log @@ Js.Json.stringify (Js.Json.object_ dict)
</code></pre></pre>
</div>
</div>
<pre><span id="VALstringifyAny"><span class="keyword">val</span> stringifyAny</span> : <code class="type">'a -> string option</code></pre><div class="info ">
<div class="not-examples">
<code class="code">stringifyAny value</code> formats any <code class="code">value</code> into a JSON string<br>
<div class="tag"><b>See also</b> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">MDN</a><br>
</div>
</div>
<div class="examples">
<pre class="example"><pre class="codepre"><code class="code">(* prints `["foo", "bar"]` *)
Js.log @@ Js.Json.stringify [| "foo"; "bar" |]
</code></pre></pre>
</div>
</div>
<pre><span id="VALreify_type"><span class="keyword">val</span> reify_type</span> : <code class="type">'a -> 'b <a href="Js_json.html#TYPEkind">kind</a> * 'b</code></pre><div class="info ">
<div class="not-examples">
<div class="warning">
<span class="label">
Deprecated.
</span>
Please use <a href="Js_json.html#VALreifyType"><code class="code">Js_json.reifyType</code></a> instead
</div>
</div>
<div class="examples">
</div>
</div>
</body></html>