Skip to content

Commit 9202bc1

Browse files
bobzhangbobzhang
committed
update docs
1 parent e9e5dfa commit 9202bc1

File tree

208 files changed

+864
-509
lines changed

Some content is hidden

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

208 files changed

+864
-509
lines changed

‎docs/api/Belt.Array.html

+61-15
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>
@@ -136,7 +135,7 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
136135
<code class="code">get arr i</code>
137136
<p>
138137

139-
If <code class="code">i &lt;= 0 &lt;= length arr</code>;returns <code class="code">Some value</code> where <code class="code">value</code> is the item at index <code class="code">i</code>
138+
If <code class="code">i &lt;= 0 &lt;= length arr</code>;returns <code class="code">Some value</code> where <code class="code">value</code> is the item at index <code class="code">i</code>
140139
If <code class="code">i</code> is out of range;returns <code class="code">None</code><br>
141140

142141
</div>
@@ -183,7 +182,7 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
183182
<p>
184183

185184
It does the samething in the runtime as <a href="Belt_Array.html#VALgetUnsafe"><code class="code">Belt_Array.getUnsafe</code></a>;
186-
it is <i>type safe</i> since the return type still track whether it is
185+
it is <i>type safe</i> since the return type still track whether it is
187186
in range or not<br>
188187

189188
</div>
@@ -293,7 +292,7 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
293292

294293
<pre><span id="VALmake"><span class="keyword">val</span> make</span> : <code class="type">int -> 'a -> 'a array</code></pre><div class="info ">
295294
<div class="not-examples">
296-
<code class="code">make n e</code>
295+
<code class="code">make n e</code>
297296
return an array of size <code class="code">n</code> filled with value <code class="code">e</code><br>
298297
<div class="tag"> <b>Returns</b> an empty array when <code class="code">n</code> is negative.<br>
299298
</div>
@@ -329,7 +328,7 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
329328
rangeBy 33 0 ~step:1 = [||];;
330329
rangeBy 33 0 ~step:(-1) = [||];;
331330
rangeBy 3 12 ~step:(-1) = [||];;
332-
rangeBy 3 3 ~step:0 = [||] ;;
331+
rangeBy 3 3 ~step:0 = [||] ;;
333332
rangeBy 3 3 ~step:(1) = [|3|] ;;
334333
</code></pre> </pre>
335334
</div>
@@ -339,10 +338,10 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
339338
<pre><span id="VALmakeByU"><span class="keyword">val</span> makeByU</span> : <code class="type">int -> (int -> 'a [@bs]) -> 'a array</code></pre>
340339
<pre><span id="VALmakeBy"><span class="keyword">val</span> makeBy</span> : <code class="type">int -> (int -> 'a) -> 'a array</code></pre><div class="info ">
341340
<div class="not-examples">
342-
<code class="code">makeBy n f</code>
341+
<code class="code">makeBy n f</code>
343342
<p>
344343

345-
return an empty array when <code class="code">n</code> is negative
344+
return an empty array when <code class="code">n</code> is negative
346345
return an array of size <code class="code">n</code> populated by <code class="code">f i</code> start from <code class="code">0</code> to <code class="code">n - 1</code><br>
347346

348347
</div>
@@ -369,7 +368,7 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
369368

370369
<pre><span id="VALzip"><span class="keyword">val</span> zip</span> : <code class="type">'a array -> 'b array -> ('a * 'b) array</code></pre><div class="info ">
371370
<div class="not-examples">
372-
<code class="code">zip a b</code>
371+
<code class="code">zip a b</code>
373372
<p>
374373

375374
Create an array of pairs from corresponding elements of <code class="code">a</code> and <code class="code">b</code>.
@@ -473,6 +472,26 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
473472
</div>
474473

475474

475+
<pre><span id="VALsliceToEnd"><span class="keyword">val</span> sliceToEnd</span> : <code class="type">'a array -> int -> 'a array</code></pre><div class="info ">
476+
<div class="not-examples">
477+
<code class="code">sliceToEnd xs offset</code> creates a new array with the elements of <code class="code">xs</code> starting at <code class="code">offset</code>
478+
<p>
479+
480+
<code class="code">offset</code> can be negative;and is evaluated as <code class="code">length xs - offset</code>
481+
<code class="code">sliceToEnd xs -1</code> means get the last element as a singleton array
482+
<p>
483+
484+
<code class="code">sliceToEnd xs 0</code> will return a copy of the array<br>
485+
486+
</div>
487+
<div class="examples">
488+
<pre class="example"> <pre class="codepre"><code class="code"> sliceToEnd [|10;11;12;13;14;15;16|] 2 = [|12;13;14;15;16|];;
489+
sliceToEnd [|10;11;12;13;14;15;16|] (-4) = [|13;14;15;16|];;
490+
</code></pre> </pre>
491+
</div>
492+
</div>
493+
494+
476495
<pre><span id="VALcopy"><span class="keyword">val</span> copy</span> : <code class="type">'a array -> 'a array</code></pre><div class="info ">
477496
<div class="not-examples">
478497
<code class="code">copy a</code><br>
@@ -486,7 +505,7 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
486505

487506
<pre><span id="VALfill"><span class="keyword">val</span> fill</span> : <code class="type">'a array -> offset:int -> len:int -> 'a -> unit</code></pre><div class="info ">
488507
<div class="not-examples">
489-
<code class="code">fill arr ~offset ~len x</code>
508+
<code class="code">fill arr ~offset ~len x</code>
490509
<p>
491510

492511
Modifies <code class="code">arr</code> in place,
@@ -513,20 +532,20 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
513532

514533
<pre><span id="VALblit"><span class="keyword">val</span> blit</span> : <code class="type">src:'a array -><br> srcOffset:int -> dst:'a array -> dstOffset:int -> len:int -> unit</code></pre><div class="info ">
515534
<div class="not-examples">
516-
<code class="code">blit ~src:v1 ~srcOffset:o1 ~dst:v2 ~dstOffset:o2 ~len</code>
535+
<code class="code">blit ~src:v1 ~srcOffset:o1 ~dst:v2 ~dstOffset:o2 ~len</code>
517536
<p>
518537

519538
copies <code class="code">len</code> elements
520539
from array <code class="code">v1</code>;starting at element number <code class="code">o1</code>;to array <code class="code">v2</code>,
521-
starting at element number <code class="code">o2</code>.
540+
starting at element number <code class="code">o2</code>.
522541
<p>
523542

524543
It works correctly even if
525544
<code class="code">v1</code> and <code class="code">v2</code> are the same array;and the source and
526545
destination chunks overlap.
527546
<p>
528547

529-
<code class="code">offset</code> can be negative;<code class="code">-1</code> means <code class="code">len - 1</code>;if <code class="code">len + offset</code> is still
548+
<code class="code">offset</code> can be negative;<code class="code">-1</code> means <code class="code">len - 1</code>;if <code class="code">len + offset</code> is still
530549
negative;it will be set as 0
531550
<p>
532551

@@ -571,7 +590,7 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
571590
Item: b
572591
Item: c
573592
*)
574-
593+
575594
let total = ref 0;;
576595
forEach [|1;2;3;4|] (fun x -&gt; total := !total + x);;
577596
!total = 1 + 2 + 3 + 4;;
@@ -610,6 +629,20 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
610629
</div>
611630

612631

632+
<pre><span id="VALkeepWithIndexU"><span class="keyword">val</span> keepWithIndexU</span> : <code class="type">'a array -> ('a -> int -> bool [@bs]) -> 'a array</code></pre>
633+
<pre><span id="VALkeepWithIndex"><span class="keyword">val</span> keepWithIndex</span> : <code class="type">'a array -> ('a -> int -> bool) -> 'a array</code></pre><div class="info ">
634+
<div class="not-examples">
635+
<code class="code">keepWithIndex xs p </code><br>
636+
<div class="tag"> <b>Returns</b> a new array that keep all elements satisfy <code class="code">p</code><br>
637+
</div>
638+
</div>
639+
<div class="examples">
640+
<pre class="example"> <pre class="codepre"><code class="code"> keepWithIndex [|1;2;3|] (fun _x i -&gt; i = 1) = [|2|]
641+
</code></pre> </pre>
642+
</div>
643+
</div>
644+
645+
613646
<pre><span id="VALkeepMapU"><span class="keyword">val</span> keepMapU</span> : <code class="type">'a array -> ('a -> 'b option [@bs]) -> 'b array</code></pre>
614647
<pre><span id="VALkeepMap"><span class="keyword">val</span> keepMap</span> : <code class="type">'a array -> ('a -> 'b option) -> 'b array</code></pre><div class="info ">
615648
<div class="not-examples">
@@ -636,8 +669,7 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
636669

637670
</div>
638671
<div class="examples">
639-
<pre class="example"> <pre class="codepre"><code class="code">
640-
forEach [|"a";"b";"c"|] (fun i x -&gt; Js.log("Item " ^ (string_of_int i) ^ " is " ^ x));;
672+
<pre class="example"> <pre class="codepre"><code class="code"> forEach [|"a";"b";"c"|] (fun i x -&gt; Js.log("Item " ^ (string_of_int i) ^ " is " ^ x));;
641673
(* prints:
642674
Item 0 is a
643675
Item 1 is b
@@ -670,6 +702,20 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
670702
</div>
671703

672704

705+
<pre><span id="VALpartitionU"><span class="keyword">val</span> partitionU</span> : <code class="type">'a array -> ('a -> bool [@bs]) -> 'a array * 'a array</code></pre>
706+
<pre><span id="VALpartition"><span class="keyword">val</span> partition</span> : <code class="type">'a array -> ('a -> bool) -> 'a array * 'a array</code></pre><div class="info ">
707+
<div class="not-examples">
708+
<code class="code">partition f a</code> split array into tuple of two arrays based on predicate f; first of tuple where predicate cause true, second where predicate cause false<br>
709+
710+
</div>
711+
<div class="examples">
712+
<pre class="example"> <pre class="codepre"><code class="code"> predicate [|1;2;3;4;5|] (fun x -&gt; if x mod 2 = 0) = ([|2;4|], [|1;2;3|]);;
713+
predicate [|1;2;3;4;5|] (fun x -&gt; if x mod 2 &lt;&gt; 0) = ([|1;2;3|], [|2;4|]);;
714+
</code></pre> </pre>
715+
</div>
716+
</div>
717+
718+
673719
<pre><span id="VALreduceU"><span class="keyword">val</span> reduceU</span> : <code class="type">'b array -> 'a -> ('a -> 'b -> 'a [@bs]) -> 'a</code></pre>
674720
<pre><span id="VALreduce"><span class="keyword">val</span> reduce</span> : <code class="type">'b array -> 'a -> ('a -> 'b -> 'a) -> 'a</code></pre><div class="info ">
675721
<div class="not-examples">

‎docs/api/Belt.Debug.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.HashMap.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.HashSet.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.Id.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.List.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.Map.html

+15-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>
@@ -244,6 +243,21 @@ <h1>Module <a href="type_Belt.Map.html">Belt.Map</a></h1>
244243
</div>
245244

246245

246+
<pre><span id="VALfindFirstByU"><span class="keyword">val</span> findFirstByU</span> : <code class="type">('k, 'v, 'id) <a href="Belt_Map.html#TYPEt">t</a> -> ('k -> 'v -> bool [@bs]) -> ('k * 'v) option</code></pre>
247+
<pre><span id="VALfindFirstBy"><span class="keyword">val</span> findFirstBy</span> : <code class="type">('k, 'v, 'id) <a href="Belt_Map.html#TYPEt">t</a> -> ('k -> 'v -> bool) -> ('k * 'v) option</code></pre><div class="info ">
248+
<div class="not-examples">
249+
<code class="code">findFirstBy m p</code> uses funcion <code class="code">f</code> to find the first key value pair
250+
to match predicate <code class="code">p</code>.<br>
251+
252+
</div>
253+
<div class="examples">
254+
<pre class="example"> <pre class="codepre"><code class="code"> let s0 = fromArray ~id:(module IntCmp) [|4,"4";1,"1";2,"2,"3""|];;
255+
findFirstBy s0 (fun k v -&gt; k = 4 ) = option (4, "4");;
256+
</code></pre> </pre>
257+
</div>
258+
</div>
259+
260+
247261
<pre><span id="VALforEachU"><span class="keyword">val</span> forEachU</span> : <code class="type">('k, 'v, 'id) <a href="Belt_Map.html#TYPEt">t</a> -> ('k -> 'v -> unit [@bs]) -> unit</code></pre>
248262
<pre><span id="VALforEach"><span class="keyword">val</span> forEach</span> : <code class="type">('k, 'v, 'id) <a href="Belt_Map.html#TYPEt">t</a> -> ('k -> 'v -> unit) -> unit</code></pre><div class="info ">
249263
<div class="not-examples">

‎docs/api/Belt.MutableMap.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.MutableQueue.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.MutableSet.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.MutableStack.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.Option.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.Range.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.Result.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.Set.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

‎docs/api/Belt.SortArray.html

-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
<li><a href="Dom_storage.html">Dom_storage</a></li>
5858
<li><a href="Js.html">Js</a></li>
5959
<li><a href="Js_array.html">Js_array</a></li>
60-
<li><a href="Js_boolean.html">Js_boolean</a></li>
6160
<li><a href="Js_cast.html">Js_cast</a></li>
6261
<li><a href="Js_console.html">Js_console</a></li>
6362
<li><a href="Js_date.html">Js_date</a></li>

0 commit comments

Comments
 (0)