Skip to content

Commit 46e4de9

Browse files
bobzhangbobzhang
committed
update docs
1 parent 91d381e commit 46e4de9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+3926
-1025
lines changed

‎docs/api/Belt.Array.html

+248-70
Large diffs are not rendered by default.

‎docs/api/Belt.List.html

+193-77
Large diffs are not rendered by default.

‎docs/api/Belt.Map.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,10 @@ <h1>Module <a href="type_Belt.Map.html">Belt.Map</a></h1>
107107
<p>
108108

109109
It also has three specialized inner modules
110-
<code class="code">Belt.Map.Int</code> and <code class="code">Belt.Map.String</code>
110+
<code class="code">Belt.Map.Int</code>, <code class="code">Belt.Map.String</code> and
111111
<p>
112112

113-
<code class="code">Belt.Map.Dict</code>: This module separate date from function
113+
<code class="code">Belt.Map.Dict</code>: This module separates data from function
114114
which is more verbose but slightly more efficient<br>
115115

116116
</div>

‎docs/api/Belt.Set.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,10 @@ <h1>Module <a href="type_Belt.Set.html">Belt.Set</a></h1>
107107
<p>
108108

109109
It also has three specialized inner modules
110-
<code class="code">Belt.Set.Int</code> and <code class="code">Belt.Set.String</code>
110+
<code class="code">Belt.Set.Int</code>, <code class="code">Belt.Set.String</code> and
111111
<p>
112112

113-
<code class="code">Belt.Set.Dict</code>: This module separate date from function
113+
<code class="code">Belt.Set.Dict</code>: This module separates data from function
114114
which is more verbose but slightly more efficient<br>
115115

116116
</div>

‎docs/api/Belt.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -298,10 +298,10 @@ <h1>Module <a href="type_Belt.html">Belt</a></h1>
298298
<p>
299299

300300
It also has three specialized inner modules
301-
<code class="code">Belt.Set.Int</code> and <code class="code">Belt.Set.String</code>
301+
<code class="code">Belt.Set.Int</code>, <code class="code">Belt.Set.String</code> and
302302
<p>
303303

304-
<code class="code">Belt.Set.Dict</code>: This module separate date from function
304+
<code class="code">Belt.Set.Dict</code>: This module separates data from function
305305
which is more verbose but slightly more efficient<br>
306306

307307
</div>
@@ -315,10 +315,10 @@ <h1>Module <a href="type_Belt.html">Belt</a></h1>
315315
<p>
316316

317317
It also has three specialized inner modules
318-
<code class="code">Belt.Map.Int</code> and <code class="code">Belt.Map.String</code>
318+
<code class="code">Belt.Map.Int</code>, <code class="code">Belt.Map.String</code> and
319319
<p>
320320

321-
<code class="code">Belt.Map.Dict</code>: This module separate date from function
321+
<code class="code">Belt.Map.Dict</code>: This module separates data from function
322322
which is more verbose but slightly more efficient<br>
323323

324324
</div>

‎docs/api/Belt_Array.html

+248-70
Large diffs are not rendered by default.

‎docs/api/Belt_List.html

+193-77
Large diffs are not rendered by default.

‎docs/api/Belt_internalMapInt.A.html

+248-70
Large diffs are not rendered by default.

‎docs/api/Belt_internalMapString.A.html

+248-70
Large diffs are not rendered by default.

‎docs/api/Belt_internalSetInt.A.html

+248-70
Large diffs are not rendered by default.

‎docs/api/Belt_internalSetString.A.html

+248-70
Large diffs are not rendered by default.

‎docs/api/Js.Boolean.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,4 +108,4 @@ <h1>Module <a href="type_Js.Boolean.html">Js.Boolean</a></h1>
108108

109109
<hr width="100%">
110110

111-
<pre><span id="VALto_js_boolean"><span class="keyword">val</span> to_js_boolean</span> : <code class="type">bool -> <a href="Js.html#TYPEboolean">Js.boolean</a></code></pre></body></html>
111+
<pre><span id="VALto_js_boolean"><span class="keyword">val</span> to_js_boolean</span> : <code class="type">bool -> bool</code></pre></body></html>

‎docs/api/Js.Console.html

+2
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,9 @@ <h1>Module <a href="type_Js.Console.html">Js.Console</a></h1>
9999

100100
<pre><span class="keyword">module</span> Console: <code class="type"><a href="Js_console.html">Js_console</a></code></pre><hr width="100%">
101101

102+
<pre><span id="VALerror"><span class="keyword">val</span> error</span> : <code class="type">'a -> unit</code></pre>
102103
<pre><span id="VALlog"><span class="keyword">val</span> log</span> : <code class="type">'a -> unit</code></pre>
104+
<pre><span id="VALtrace"><span class="keyword">val</span> trace</span> : <code class="type">unit -> unit</code></pre>
103105
<pre><span id="VALwarn"><span class="keyword">val</span> warn</span> : <code class="type">'a -> unit</code></pre>
104106
<pre><span id="VALtimeStart"><span class="keyword">val</span> timeStart</span> : <code class="type">string -> unit</code></pre>
105107
<pre><span id="VALtimeEnd"><span class="keyword">val</span> timeEnd</span> : <code class="type">string -> unit</code></pre></body></html>

‎docs/api/Js.Json.html

+30-6
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ <h1>Module <a href="type_Js.Json.html">Js.Json</a></h1>
153153
<td align="left" valign="top" >
154154
<code><span class="keyword">|</span></code></td>
155155
<td align="left" valign="top" >
156-
<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>
156+
<code><span id="TYPEELTkind.Boolean"><span class="constructor">Boolean</span></span></td><td><span class="keyword">:</span></td><td><code class="type">bool <a href="Js_json.html#TYPEkind">kind</a></code></code></td>
157157

158158
</tr>
159159
<tr>
@@ -279,7 +279,7 @@ <h1>Module <a href="type_Js.Json.html">Js.Json</a></h1>
279279
</div>
280280

281281

282-
<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 ">
282+
<pre><span id="VALdecodeBoolean"><span class="keyword">val</span> decodeBoolean</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> -> bool option</code></pre><div class="info ">
283283
<div class="not-examples">
284284
<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>
285285
otherwise<br>
@@ -326,9 +326,9 @@ <h1>Module <a href="type_Js.Json.html">Js.Json</a></h1>
326326
</div>
327327

328328

329-
<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 ">
329+
<pre><span id="VALboolean"><span class="keyword">val</span> boolean</span> : <code class="type">bool -> <a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
330330
<div class="not-examples">
331-
<code class="code">boolean b</code> makes a JSON boolean of the <code class="code">Js.boolean</code> <code class="code">b</code><br>
331+
<code class="code">boolean b</code> makes a JSON boolean of the <code class="code">bool</code> <code class="code">b</code><br>
332332

333333
</div>
334334

@@ -371,9 +371,9 @@ <h1>Module <a href="type_Js.Json.html">Js.Json</a></h1>
371371
</div>
372372

373373

374-
<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 ">
374+
<pre><span id="VALbooleanArray"><span class="keyword">val</span> booleanArray</span> : <code class="type">bool array -> <a href="Js_json.html#TYPEt">t</a></code></pre><div class="info ">
375375
<div class="not-examples">
376-
<code class="code">booleanArray</code> makes a JSON array of the <code class="code">Js.boolean array</code> <code class="code">a</code><br>
376+
<code class="code">booleanArray</code> makes a JSON array of the <code class="code">bool array</code> <code class="code">a</code><br>
377377

378378
</div>
379379

@@ -467,6 +467,30 @@ <h1>Module <a href="type_Js.Json.html">Js.Json</a></h1>
467467
</div>
468468

469469

470+
<pre><span id="VALstringifyWithSpace"><span class="keyword">val</span> stringifyWithSpace</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> -> int -> string</code></pre><div class="info ">
471+
<div class="not-examples">
472+
<code class="code">stringify json</code> formats the JSON data structure as a string
473+
<p>
474+
475+
<b>Returns</b> the string representation of a given JSON data structure<br>
476+
<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>
477+
</div>
478+
</div>
479+
<div class="examples">
480+
<pre class="example"> <pre class="codepre"><code class="code">(* Creates and stringifies a simple JS object with spacing *)
481+
482+
let dict = Js.Dict.empty () in
483+
Js.Dict.set dict "name" (Js.Json.string "John Doe");
484+
Js.Dict.set dict "age" (Js.Json.numberOfInt 30);
485+
Js.Dict.set dict "likes"
486+
(Js.Json.stringArray [|"bucklescript";"ocaml";"js"|]);
487+
488+
Js.log @@ Js.Json.stringify (Js.Json.object_ dict) 2
489+
</code></pre> </pre>
490+
</div>
491+
</div>
492+
493+
470494
<pre><span id="VALstringifyAny"><span class="keyword">val</span> stringifyAny</span> : <code class="type">'a -> string option</code></pre><div class="info ">
471495
<div class="not-examples">
472496
<code class="code">stringifyAny value</code> formats any <code class="code">value</code> into a JSON string<br>

0 commit comments

Comments
 (0)