Skip to content

Commit e96264a

Browse files
committed
add docs and build fix
1 parent 33e694a commit e96264a

Some content is hidden

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

47 files changed

+457
-1980
lines changed

Diff for: docs/api/Belt.Array.html

+18
Original file line numberDiff line numberDiff line change
@@ -767,6 +767,24 @@ <h1>Module <a href="type_Belt.Array.html">Belt.Array</a></h1>
767767
</div>
768768

769769

770+
<pre><span id="VALreduceWithIndexU"><span class="keyword">val</span> reduceWithIndexU</span> : <code class="type">'a array -> 'b -> ('b -> 'a -> int -> 'b [@bs]) -> 'b</code></pre>
771+
<pre><span id="VALreduceWithIndex"><span class="keyword">val</span> reduceWithIndex</span> : <code class="type">'a array -> 'b -> ('b -> 'a -> int -> 'b) -> 'b</code></pre><div class="info ">
772+
<div class="not-examples">
773+
<code class="code">reduceWithIndex xs f</code>
774+
<p>
775+
776+
Applies <code class="code">f</code> to each element of <code class="code">xs</code> from beginning to end. Function <code class="code">f</code> has three parameters: the item
777+
from the array and an “accumulator”, which starts with a value of <code class="code">init</code> and the index of each element. <code class="code">reduceWithIndex</code>
778+
returns the final value of the accumulator.<br>
779+
780+
</div>
781+
<div class="examples">
782+
<pre class="example"> <pre class="codepre"><code class="code"> reduceWithIndex [|1;2;3;4|] 0 (fun acc x i -&gt; acc + x + i) = 16;
783+
</code></pre> </pre>
784+
</div>
785+
</div>
786+
787+
770788
<pre><span id="VALsomeU"><span class="keyword">val</span> someU</span> : <code class="type">'a array -> ('a -> bool [@bs]) -> bool</code></pre>
771789
<pre><span id="VALsome"><span class="keyword">val</span> some</span> : <code class="type">'a array -> ('a -> bool) -> bool</code></pre><div class="info ">
772790
<div class="not-examples">

Diff for: docs/api/Belt.List.html

+27
Original file line numberDiff line numberDiff line change
@@ -856,6 +856,19 @@ <h1>Module <a href="type_Belt.List.html">Belt.List</a></h1>
856856
</div>
857857

858858

859+
<pre><span id="VALfilter"><span class="keyword">val</span> filter</span> : <code class="type">'a <a href="Belt_List.html#TYPEt">t</a> -> ('a -> bool) -> 'a <a href="Belt_List.html#TYPEt">t</a></code></pre><div class="info ">
860+
<div class="not-examples">
861+
<code class="code">filter xs p</code> returns a list of all elements in <code class="code">xs</code> which satisfy the predicate function <code class="code">p</code><br>
862+
863+
</div>
864+
<div class="examples">
865+
<pre class="example"> <pre class="codepre"><code class="code"> filter [1;2;3;4] (fun x -&gt; x mod 2 = 0) =
866+
[2;4]
867+
</code></pre> </pre>
868+
</div>
869+
</div>
870+
871+
859872
<pre><span id="VALkeepWithIndexU"><span class="keyword">val</span> keepWithIndexU</span> : <code class="type">'a <a href="Belt_List.html#TYPEt">t</a> -> ('a -> int -> bool [@bs]) -> 'a <a href="Belt_List.html#TYPEt">t</a></code></pre>
860873
<pre><span id="VALkeepWithIndex"><span class="keyword">val</span> keepWithIndex</span> : <code class="type">'a <a href="Belt_List.html#TYPEt">t</a> -> ('a -> int -> bool) -> 'a <a href="Belt_List.html#TYPEt">t</a></code></pre><div class="info ">
861874
<div class="not-examples">
@@ -871,6 +884,20 @@ <h1>Module <a href="type_Belt.List.html">Belt.List</a></h1>
871884
</div>
872885

873886

887+
<pre><span id="VALfilterWithIndex"><span class="keyword">val</span> filterWithIndex</span> : <code class="type">'a <a href="Belt_List.html#TYPEt">t</a> -> ('a -> int -> bool) -> 'a <a href="Belt_List.html#TYPEt">t</a></code></pre><div class="info ">
888+
<div class="not-examples">
889+
<code class="code">filterWithIndex xs p</code> returns a list of all elements in <code class="code">xs</code> which satisfy the predicate function <code class="code">p</code><br>
890+
891+
</div>
892+
<div class="examples">
893+
<pre class="example"> <pre class="codepre"><code class="code"> filterWithIndex [1;2;3;4] (fun _x i -&gt; i mod 2 = 0)
894+
=
895+
[1;3]
896+
</code></pre> </pre>
897+
</div>
898+
</div>
899+
900+
874901
<pre><span id="VALkeepMapU"><span class="keyword">val</span> keepMapU</span> : <code class="type">'a <a href="Belt_List.html#TYPEt">t</a> -> ('a -> 'b option [@bs]) -> 'b <a href="Belt_List.html#TYPEt">t</a></code></pre>
875902
<pre><span id="VALkeepMap"><span class="keyword">val</span> keepMap</span> : <code class="type">'a <a href="Belt_List.html#TYPEt">t</a> -> ('a -> 'b option) -> 'b <a href="Belt_List.html#TYPEt">t</a></code></pre><div class="info ">
876903
<div class="not-examples">

Diff for: docs/api/Belt_Array.html

+18
Original file line numberDiff line numberDiff line change
@@ -765,6 +765,24 @@ <h1>Module <a href="type_Belt_Array.html">Belt_Array</a></h1>
765765
</div>
766766

767767

768+
<pre><span id="VALreduceWithIndexU"><span class="keyword">val</span> reduceWithIndexU</span> : <code class="type">'a array -> 'b -> ('b -> 'a -> int -> 'b [@bs]) -> 'b</code></pre>
769+
<pre><span id="VALreduceWithIndex"><span class="keyword">val</span> reduceWithIndex</span> : <code class="type">'a array -> 'b -> ('b -> 'a -> int -> 'b) -> 'b</code></pre><div class="info ">
770+
<div class="not-examples">
771+
<code class="code">reduceWithIndex xs f</code>
772+
<p>
773+
774+
Applies <code class="code">f</code> to each element of <code class="code">xs</code> from beginning to end. Function <code class="code">f</code> has three parameters: the item
775+
from the array and an “accumulator”, which starts with a value of <code class="code">init</code> and the index of each element. <code class="code">reduceWithIndex</code>
776+
returns the final value of the accumulator.<br>
777+
778+
</div>
779+
<div class="examples">
780+
<pre class="example"> <pre class="codepre"><code class="code"> reduceWithIndex [|1;2;3;4|] 0 (fun acc x i -&gt; acc + x + i) = 16;
781+
</code></pre> </pre>
782+
</div>
783+
</div>
784+
785+
768786
<pre><span id="VALsomeU"><span class="keyword">val</span> someU</span> : <code class="type">'a array -> ('a -> bool [@bs]) -> bool</code></pre>
769787
<pre><span id="VALsome"><span class="keyword">val</span> some</span> : <code class="type">'a array -> ('a -> bool) -> bool</code></pre><div class="info ">
770788
<div class="not-examples">

Diff for: docs/api/Belt_List.html

+27
Original file line numberDiff line numberDiff line change
@@ -862,6 +862,19 @@ <h1>Module <a href="type_Belt_List.html">Belt_List</a></h1>
862862
</div>
863863

864864

865+
<pre><span id="VALfilter"><span class="keyword">val</span> filter</span> : <code class="type">'a <a href="Belt_List.html#TYPEt">t</a> -> ('a -> bool) -> 'a <a href="Belt_List.html#TYPEt">t</a></code></pre><div class="info ">
866+
<div class="not-examples">
867+
<code class="code">filter xs p</code> returns a list of all elements in <code class="code">xs</code> which satisfy the predicate function <code class="code">p</code><br>
868+
869+
</div>
870+
<div class="examples">
871+
<pre class="example"> <pre class="codepre"><code class="code"> filter [1;2;3;4] (fun x -&gt; x mod 2 = 0) =
872+
[2;4]
873+
</code></pre> </pre>
874+
</div>
875+
</div>
876+
877+
865878
<pre><span id="VALkeepWithIndexU"><span class="keyword">val</span> keepWithIndexU</span> : <code class="type">'a <a href="Belt_List.html#TYPEt">t</a> -> ('a -> int -> bool [@bs]) -> 'a <a href="Belt_List.html#TYPEt">t</a></code></pre>
866879
<pre><span id="VALkeepWithIndex"><span class="keyword">val</span> keepWithIndex</span> : <code class="type">'a <a href="Belt_List.html#TYPEt">t</a> -> ('a -> int -> bool) -> 'a <a href="Belt_List.html#TYPEt">t</a></code></pre><div class="info ">
867880
<div class="not-examples">
@@ -877,6 +890,20 @@ <h1>Module <a href="type_Belt_List.html">Belt_List</a></h1>
877890
</div>
878891

879892

893+
<pre><span id="VALfilterWithIndex"><span class="keyword">val</span> filterWithIndex</span> : <code class="type">'a <a href="Belt_List.html#TYPEt">t</a> -> ('a -> int -> bool) -> 'a <a href="Belt_List.html#TYPEt">t</a></code></pre><div class="info ">
894+
<div class="not-examples">
895+
<code class="code">filterWithIndex xs p</code> returns a list of all elements in <code class="code">xs</code> which satisfy the predicate function <code class="code">p</code><br>
896+
897+
</div>
898+
<div class="examples">
899+
<pre class="example"> <pre class="codepre"><code class="code"> filterWithIndex [1;2;3;4] (fun _x i -&gt; i mod 2 = 0)
900+
=
901+
[1;3]
902+
</code></pre> </pre>
903+
</div>
904+
</div>
905+
906+
880907
<pre><span id="VALkeepMapU"><span class="keyword">val</span> keepMapU</span> : <code class="type">'a <a href="Belt_List.html#TYPEt">t</a> -> ('a -> 'b option [@bs]) -> 'b <a href="Belt_List.html#TYPEt">t</a></code></pre>
881908
<pre><span id="VALkeepMap"><span class="keyword">val</span> keepMap</span> : <code class="type">'a <a href="Belt_List.html#TYPEt">t</a> -> ('a -> 'b option) -> 'b <a href="Belt_List.html#TYPEt">t</a></code></pre><div class="info ">
882909
<div class="not-examples">

Diff for: docs/api/Belt_internalAVLset.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h1>Module <a href="type_Belt_internalAVLset.html">Belt_internalAVLset</a></h1>
126126
<pre><span id="VALminUndefined"><span class="keyword">val</span> minUndefined</span> : <code class="type">'a t -> 'a <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre>
127127
<pre><span id="VALmaximum"><span class="keyword">val</span> maximum</span> : <code class="type">'a t -> 'a option</code></pre>
128128
<pre><span id="VALmaxUndefined"><span class="keyword">val</span> maxUndefined</span> : <code class="type">'a t -> 'a <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre>
129-
<pre><span id="VALremoveMinAuxWithRef"><span class="keyword">val</span> removeMinAuxWithRef</span> : <code class="type">'a node -> 'a Pervasives.ref -> 'a t</code></pre>
129+
<pre><span id="VALremoveMinAuxWithRef"><span class="keyword">val</span> removeMinAuxWithRef</span> : <code class="type">'a node -> 'a Bs_stdlib_mini.ref -> 'a t</code></pre>
130130
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type">'a t</code></pre>
131131
<pre><span id="VALisEmpty"><span class="keyword">val</span> isEmpty</span> : <code class="type">'a t -> bool</code></pre>
132132
<pre><span id="VALstackAllLeft"><span class="keyword">val</span> stackAllLeft</span> : <code class="type">'a t -> 'a node list -> 'a node list</code></pre>

Diff for: docs/api/Belt_internalAVLtree.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ <h1>Module <a href="type_Belt_internalAVLtree.html">Belt_internalAVLtree</a></h1
131131
<pre><span id="VALminUndefined"><span class="keyword">val</span> minUndefined</span> : <code class="type">('a, 'b) t -> ('a * 'b) <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre>
132132
<pre><span id="VALmaximum"><span class="keyword">val</span> maximum</span> : <code class="type">('a, 'b) t -> ('a * 'b) option</code></pre>
133133
<pre><span id="VALmaxUndefined"><span class="keyword">val</span> maxUndefined</span> : <code class="type">('a, 'b) t -> ('a * 'b) <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre>
134-
<pre><span id="VALremoveMinAuxWithRef"><span class="keyword">val</span> removeMinAuxWithRef</span> : <code class="type">('a, 'b) node -> 'a Pervasives.ref -> 'b Pervasives.ref -> ('a, 'b) t</code></pre>
134+
<pre><span id="VALremoveMinAuxWithRef"><span class="keyword">val</span> removeMinAuxWithRef</span> : <code class="type">('a, 'b) node -> 'a Bs_stdlib_mini.ref -> 'b Bs_stdlib_mini.ref -> ('a, 'b) t</code></pre>
135135
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type">('a, 'b) t</code></pre>
136136
<pre><span id="VALisEmpty"><span class="keyword">val</span> isEmpty</span> : <code class="type">('a, 'b) t -> bool</code></pre>
137137
<pre><span id="VALstackAllLeft"><span class="keyword">val</span> stackAllLeft</span> : <code class="type">('a, 'b) t -> ('a, 'b) node list -> ('a, 'b) node list</code></pre>

Diff for: docs/api/Belt_internalMapInt.A.html

+18
Original file line numberDiff line numberDiff line change
@@ -756,6 +756,24 @@ <h1>Module <a href="type_Belt_internalMapInt.A.html">Belt_internalMapInt.A</a></
756756
</div>
757757

758758

759+
<pre><span id="VALreduceWithIndexU"><span class="keyword">val</span> reduceWithIndexU</span> : <code class="type">'a array -> 'b -> ('b -> 'a -> int -> 'b [@bs]) -> 'b</code></pre>
760+
<pre><span id="VALreduceWithIndex"><span class="keyword">val</span> reduceWithIndex</span> : <code class="type">'a array -> 'b -> ('b -> 'a -> int -> 'b) -> 'b</code></pre><div class="info ">
761+
<div class="not-examples">
762+
<code class="code">reduceWithIndex xs f</code>
763+
<p>
764+
765+
Applies <code class="code">f</code> to each element of <code class="code">xs</code> from beginning to end. Function <code class="code">f</code> has three parameters: the item
766+
from the array and an “accumulator”, which starts with a value of <code class="code">init</code> and the index of each element. <code class="code">reduceWithIndex</code>
767+
returns the final value of the accumulator.<br>
768+
769+
</div>
770+
<div class="examples">
771+
<pre class="example"> <pre class="codepre"><code class="code"> reduceWithIndex [|1;2;3;4|] 0 (fun acc x i -&gt; acc + x + i) = 16;
772+
</code></pre> </pre>
773+
</div>
774+
</div>
775+
776+
759777
<pre><span id="VALsomeU"><span class="keyword">val</span> someU</span> : <code class="type">'a array -> ('a -> bool [@bs]) -> bool</code></pre>
760778
<pre><span id="VALsome"><span class="keyword">val</span> some</span> : <code class="type">'a array -> ('a -> bool) -> bool</code></pre><div class="info ">
761779
<div class="not-examples">

Diff for: docs/api/Belt_internalMapInt.N.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ <h1>Module <a href="type_Belt_internalMapInt.N.html">Belt_internalMapInt.N</a></
122122
<pre><span id="VALminUndefined"><span class="keyword">val</span> minUndefined</span> : <code class="type">('a, 'b) t -> ('a * 'b) <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre>
123123
<pre><span id="VALmaximum"><span class="keyword">val</span> maximum</span> : <code class="type">('a, 'b) t -> ('a * 'b) option</code></pre>
124124
<pre><span id="VALmaxUndefined"><span class="keyword">val</span> maxUndefined</span> : <code class="type">('a, 'b) t -> ('a * 'b) <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre>
125-
<pre><span id="VALremoveMinAuxWithRef"><span class="keyword">val</span> removeMinAuxWithRef</span> : <code class="type">('a, 'b) node -> 'a Pervasives.ref -> 'b Pervasives.ref -> ('a, 'b) t</code></pre>
125+
<pre><span id="VALremoveMinAuxWithRef"><span class="keyword">val</span> removeMinAuxWithRef</span> : <code class="type">('a, 'b) node -> 'a Bs_stdlib_mini.ref -> 'b Bs_stdlib_mini.ref -> ('a, 'b) t</code></pre>
126126
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type">('a, 'b) t</code></pre>
127127
<pre><span id="VALisEmpty"><span class="keyword">val</span> isEmpty</span> : <code class="type">('a, 'b) t -> bool</code></pre>
128128
<pre><span id="VALstackAllLeft"><span class="keyword">val</span> stackAllLeft</span> : <code class="type">('a, 'b) t -> ('a, 'b) node list -> ('a, 'b) node list</code></pre>

Diff for: docs/api/Belt_internalMapString.A.html

+18
Original file line numberDiff line numberDiff line change
@@ -756,6 +756,24 @@ <h1>Module <a href="type_Belt_internalMapString.A.html">Belt_internalMapString.A
756756
</div>
757757

758758

759+
<pre><span id="VALreduceWithIndexU"><span class="keyword">val</span> reduceWithIndexU</span> : <code class="type">'a array -> 'b -> ('b -> 'a -> int -> 'b [@bs]) -> 'b</code></pre>
760+
<pre><span id="VALreduceWithIndex"><span class="keyword">val</span> reduceWithIndex</span> : <code class="type">'a array -> 'b -> ('b -> 'a -> int -> 'b) -> 'b</code></pre><div class="info ">
761+
<div class="not-examples">
762+
<code class="code">reduceWithIndex xs f</code>
763+
<p>
764+
765+
Applies <code class="code">f</code> to each element of <code class="code">xs</code> from beginning to end. Function <code class="code">f</code> has three parameters: the item
766+
from the array and an “accumulator”, which starts with a value of <code class="code">init</code> and the index of each element. <code class="code">reduceWithIndex</code>
767+
returns the final value of the accumulator.<br>
768+
769+
</div>
770+
<div class="examples">
771+
<pre class="example"> <pre class="codepre"><code class="code"> reduceWithIndex [|1;2;3;4|] 0 (fun acc x i -&gt; acc + x + i) = 16;
772+
</code></pre> </pre>
773+
</div>
774+
</div>
775+
776+
759777
<pre><span id="VALsomeU"><span class="keyword">val</span> someU</span> : <code class="type">'a array -> ('a -> bool [@bs]) -> bool</code></pre>
760778
<pre><span id="VALsome"><span class="keyword">val</span> some</span> : <code class="type">'a array -> ('a -> bool) -> bool</code></pre><div class="info ">
761779
<div class="not-examples">

Diff for: docs/api/Belt_internalMapString.N.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ <h1>Module <a href="type_Belt_internalMapString.N.html">Belt_internalMapString.N
122122
<pre><span id="VALminUndefined"><span class="keyword">val</span> minUndefined</span> : <code class="type">('a, 'b) t -> ('a * 'b) <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre>
123123
<pre><span id="VALmaximum"><span class="keyword">val</span> maximum</span> : <code class="type">('a, 'b) t -> ('a * 'b) option</code></pre>
124124
<pre><span id="VALmaxUndefined"><span class="keyword">val</span> maxUndefined</span> : <code class="type">('a, 'b) t -> ('a * 'b) <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre>
125-
<pre><span id="VALremoveMinAuxWithRef"><span class="keyword">val</span> removeMinAuxWithRef</span> : <code class="type">('a, 'b) node -> 'a Pervasives.ref -> 'b Pervasives.ref -> ('a, 'b) t</code></pre>
125+
<pre><span id="VALremoveMinAuxWithRef"><span class="keyword">val</span> removeMinAuxWithRef</span> : <code class="type">('a, 'b) node -> 'a Bs_stdlib_mini.ref -> 'b Bs_stdlib_mini.ref -> ('a, 'b) t</code></pre>
126126
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type">('a, 'b) t</code></pre>
127127
<pre><span id="VALisEmpty"><span class="keyword">val</span> isEmpty</span> : <code class="type">('a, 'b) t -> bool</code></pre>
128128
<pre><span id="VALstackAllLeft"><span class="keyword">val</span> stackAllLeft</span> : <code class="type">('a, 'b) t -> ('a, 'b) node list -> ('a, 'b) node list</code></pre>

Diff for: docs/api/Belt_internalSetInt.A.html

+18
Original file line numberDiff line numberDiff line change
@@ -755,6 +755,24 @@ <h1>Module <a href="type_Belt_internalSetInt.A.html">Belt_internalSetInt.A</a></
755755
</div>
756756

757757

758+
<pre><span id="VALreduceWithIndexU"><span class="keyword">val</span> reduceWithIndexU</span> : <code class="type">'a array -> 'b -> ('b -> 'a -> int -> 'b [@bs]) -> 'b</code></pre>
759+
<pre><span id="VALreduceWithIndex"><span class="keyword">val</span> reduceWithIndex</span> : <code class="type">'a array -> 'b -> ('b -> 'a -> int -> 'b) -> 'b</code></pre><div class="info ">
760+
<div class="not-examples">
761+
<code class="code">reduceWithIndex xs f</code>
762+
<p>
763+
764+
Applies <code class="code">f</code> to each element of <code class="code">xs</code> from beginning to end. Function <code class="code">f</code> has three parameters: the item
765+
from the array and an “accumulator”, which starts with a value of <code class="code">init</code> and the index of each element. <code class="code">reduceWithIndex</code>
766+
returns the final value of the accumulator.<br>
767+
768+
</div>
769+
<div class="examples">
770+
<pre class="example"> <pre class="codepre"><code class="code"> reduceWithIndex [|1;2;3;4|] 0 (fun acc x i -&gt; acc + x + i) = 16;
771+
</code></pre> </pre>
772+
</div>
773+
</div>
774+
775+
758776
<pre><span id="VALsomeU"><span class="keyword">val</span> someU</span> : <code class="type">'a array -> ('a -> bool [@bs]) -> bool</code></pre>
759777
<pre><span id="VALsome"><span class="keyword">val</span> some</span> : <code class="type">'a array -> ('a -> bool) -> bool</code></pre><div class="info ">
760778
<div class="not-examples">

0 commit comments

Comments
 (0)