docs/api/Js.Array.html

<!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="utf8">
                 <link rel="previous" href="Js.Exn.html"><link rel="next" href="Js.String.html">
                 <title> Js.Array </title></head> 
               <body>
<nav class="module-index"><ul><li><a href="Belt.html">Belt</a></li>
<li><a href="Belt_Array.html">Belt_Array</a></li>
<li><a href="Belt_Debug.html">Belt_Debug</a></li>
<li><a href="Belt_HashMap.html">Belt_HashMap</a></li>
<li><a href="Belt_HashMapInt.html">Belt_HashMapInt</a></li>
<li><a href="Belt_HashMapString.html">Belt_HashMapString</a></li>
<li><a href="Belt_HashSet.html">Belt_HashSet</a></li>
<li><a href="Belt_HashSetInt.html">Belt_HashSetInt</a></li>
<li><a href="Belt_HashSetString.html">Belt_HashSetString</a></li>
<li><a href="Belt_Id.html">Belt_Id</a></li>
<li><a href="Belt_List.html">Belt_List</a></li>
<li><a href="Belt_Map.html">Belt_Map</a></li>
<li><a href="Belt_MapDict.html">Belt_MapDict</a></li>
<li><a href="Belt_MapInt.html">Belt_MapInt</a></li>
<li><a href="Belt_MapString.html">Belt_MapString</a></li>
<li><a href="Belt_MutableMap.html">Belt_MutableMap</a></li>
<li><a href="Belt_MutableMapInt.html">Belt_MutableMapInt</a></li>
<li><a href="Belt_MutableMapString.html">Belt_MutableMapString</a></li>
<li><a href="Belt_MutableQueue.html">Belt_MutableQueue</a></li>
<li><a href="Belt_MutableSet.html">Belt_MutableSet</a></li>
<li><a href="Belt_MutableSetInt.html">Belt_MutableSetInt</a></li>
<li><a href="Belt_MutableSetString.html">Belt_MutableSetString</a></li>
<li><a href="Belt_MutableStack.html">Belt_MutableStack</a></li>
<li><a href="Belt_Option.html">Belt_Option</a></li>
<li><a href="Belt_Range.html">Belt_Range</a></li>
<li><a href="Belt_Result.html">Belt_Result</a></li>
<li><a href="Belt_Set.html">Belt_Set</a></li>
<li><a href="Belt_SetDict.html">Belt_SetDict</a></li>
<li><a href="Belt_SetInt.html">Belt_SetInt</a></li>
<li><a href="Belt_SetString.html">Belt_SetString</a></li>
<li><a href="Belt_SortArray.html">Belt_SortArray</a></li>
<li><a href="Belt_SortArrayInt.html">Belt_SortArrayInt</a></li>
<li><a href="Belt_SortArrayString.html">Belt_SortArrayString</a></li>
<li><a href="Belt_internalAVLset.html">Belt_internalAVLset</a></li>
<li><a href="Belt_internalAVLtree.html">Belt_internalAVLtree</a></li>
<li><a href="Belt_internalBuckets.html">Belt_internalBuckets</a></li>
<li><a href="Belt_internalBucketsType.html">Belt_internalBucketsType</a></li>
<li><a href="Belt_internalMapInt.html">Belt_internalMapInt</a></li>
<li><a href="Belt_internalMapString.html">Belt_internalMapString</a></li>
<li><a href="Belt_internalMutableAVLMap.html">Belt_internalMutableAVLMap</a></li>
<li><a href="Belt_internalSetBuckets.html">Belt_internalSetBuckets</a></li>
<li><a href="Belt_internalSetInt.html">Belt_internalSetInt</a></li>
<li><a href="Belt_internalSetString.html">Belt_internalSetString</a></li>
<li><a href="Dom.html">Dom</a></li>
<li><a href="Dom_storage.html">Dom_storage</a></li>
<li><a href="Js.html">Js</a></li>
<li><a href="Js_array.html">Js_array</a></li>
<li><a href="Js_cast.html">Js_cast</a></li>
<li><a href="Js_console.html">Js_console</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_json.html">Js_json</a></li>
<li><a href="Js_list.html">Js_list</a></li>
<li><a href="Js_mapperRt.html">Js_mapperRt</a></li>
<li><a href="Js_math.html">Js_math</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_option.html">Js_option</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_result.html">Js_result</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_vector.html">Js_vector</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.Exn.html" title="Js.Exn">Previous</a>
&nbsp;<a class="up" href="Js.html" title="Js">Up</a>
&nbsp;<a class="post" href="Js.String.html" title="Js.String">Next</a>
</div>
<h1>Module <a href="type_Js.Array.html">Js.Array</a></h1>

<pre><span class="keyword">module</span> Array: <code class="type"><a href="Js_array.html">Js_array</a></code></pre><hr width="100%">
<div class="type-declaration">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'a</code> t</span> = <code class="type">'a array</code> </pre>
</div>

<div class="type-declaration">
<pre><span id="TYPEarray_like"><span class="keyword">type</span> <code class="type">'a</code> array_like</span> </pre>
</div>


<pre><span id="VALfrom"><span class="keyword">val</span> from</span> : <code class="type">'a <a href="Js_array.html#TYPEarray_like">array_like</a> -> 'b array</code></pre>
<pre><span id="VALfromMap"><span class="keyword">val</span> fromMap</span> : <code class="type">'a <a href="Js_array.html#TYPEarray_like">array_like</a> -> ('a -> 'b) -> 'b array</code></pre><div class="info ">
                    <div class="not-examples">
                    ES2015<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALisArray"><span class="keyword">val</span> isArray</span> : <code class="type">'a -> bool</code></pre><div class="info ">
                    <div class="not-examples">
                    ES2015<br>
 
                    </div>
                    
                    </div>

                  <br>
ES2015<br>
<br>
ES2015<br>

<pre><span id="VALlength"><span class="keyword">val</span> length</span> : <code class="type">'a array -> int</code></pre>
<pre><span id="VALcopyWithin"><span class="keyword">val</span> copyWithin</span> : <code class="type">to_:int -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALcopyWithinFrom"><span class="keyword">val</span> copyWithinFrom</span> : <code class="type">to_:int -> from:int -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre><div class="info ">
                    <div class="not-examples">
                    ES2015<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALcopyWithinFromRange"><span class="keyword">val</span> copyWithinFromRange</span> : <code class="type">to_:int -> start:int -> end_:int -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre><div class="info ">
                    <div class="not-examples">
                    ES2015<br>
 
                    </div>
                    
                    </div>

                  <br>
ES2015<br>

<pre><span id="VALfillInPlace"><span class="keyword">val</span> fillInPlace</span> : <code class="type">'a -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALfillFromInPlace"><span class="keyword">val</span> fillFromInPlace</span> : <code class="type">'a -> from:int -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre><div class="info ">
                    <div class="not-examples">
                    ES2015<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALfillRangeInPlace"><span class="keyword">val</span> fillRangeInPlace</span> : <code class="type">'a -> start:int -> end_:int -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre><div class="info ">
                    <div class="not-examples">
                    ES2015<br>
 
                    </div>
                    
                    </div>

                  <br>
ES2015<br>

<pre><span id="VALpop"><span class="keyword">val</span> pop</span> : <code class="type">'a <a href="Js_array.html#TYPEt">t</a> -> 'a option</code></pre><div class="info ">
                    <div class="not-examples">
                    https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/push<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALpush"><span class="keyword">val</span> push</span> : <code class="type">'a -> 'a <a href="Js_array.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALpushMany"><span class="keyword">val</span> pushMany</span> : <code class="type">'a array -> 'a <a href="Js_array.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALreverseInPlace"><span class="keyword">val</span> reverseInPlace</span> : <code class="type">'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALshift"><span class="keyword">val</span> shift</span> : <code class="type">'a <a href="Js_array.html#TYPEt">t</a> -> 'a option</code></pre>
<pre><span id="VALsortInPlace"><span class="keyword">val</span> sortInPlace</span> : <code class="type">'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALsortInPlaceWith"><span class="keyword">val</span> sortInPlaceWith</span> : <code class="type">('a -> 'a -> int) -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALspliceInPlace"><span class="keyword">val</span> spliceInPlace</span> : <code class="type">pos:int -> remove:int -> add:'a array -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALremoveFromInPlace"><span class="keyword">val</span> removeFromInPlace</span> : <code class="type">pos:int -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALremoveCountInPlace"><span class="keyword">val</span> removeCountInPlace</span> : <code class="type">pos:int -> count:int -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALunshift"><span class="keyword">val</span> unshift</span> : <code class="type">'a -> 'a <a href="Js_array.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALunshiftMany"><span class="keyword">val</span> unshiftMany</span> : <code class="type">'a array -> 'a <a href="Js_array.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALappend"><span class="keyword">val</span> append</span> : <code class="type">'a -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALconcat"><span class="keyword">val</span> concat</span> : <code class="type">'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALconcatMany"><span class="keyword">val</span> concatMany</span> : <code class="type">'a <a href="Js_array.html#TYPEt">t</a> array -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALincludes"><span class="keyword">val</span> includes</span> : <code class="type">'a -> 'a <a href="Js_array.html#TYPEt">t</a> -> bool</code></pre><br>
ES2016<br>

<pre><span id="VALindexOf"><span class="keyword">val</span> indexOf</span> : <code class="type">'a -> 'a <a href="Js_array.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALindexOfFrom"><span class="keyword">val</span> indexOfFrom</span> : <code class="type">'a -> from:int -> 'a <a href="Js_array.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALjoin"><span class="keyword">val</span> join</span> : <code class="type">'a <a href="Js_array.html#TYPEt">t</a> -> string</code></pre>
<pre><span id="VALjoinWith"><span class="keyword">val</span> joinWith</span> : <code class="type">string -> 'a <a href="Js_array.html#TYPEt">t</a> -> string</code></pre>
<pre><span id="VALlastIndexOf"><span class="keyword">val</span> lastIndexOf</span> : <code class="type">'a -> 'a <a href="Js_array.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALlastIndexOfFrom"><span class="keyword">val</span> lastIndexOfFrom</span> : <code class="type">'a -> from:int -> 'a <a href="Js_array.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALlastIndexOf_start"><span class="keyword">val</span> lastIndexOf_start</span> : <code class="type">'a -> 'a <a href="Js_array.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALslice"><span class="keyword">val</span> slice</span> : <code class="type">start:int -> end_:int -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALcopy"><span class="keyword">val</span> copy</span> : <code class="type">'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALslice_copy"><span class="keyword">val</span> slice_copy</span> : <code class="type">unit -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALsliceFrom"><span class="keyword">val</span> sliceFrom</span> : <code class="type">int -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALslice_start"><span class="keyword">val</span> slice_start</span> : <code class="type">int -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALtoString"><span class="keyword">val</span> toString</span> : <code class="type">'a <a href="Js_array.html#TYPEt">t</a> -> string</code></pre>
<pre><span id="VALtoLocaleString"><span class="keyword">val</span> toLocaleString</span> : <code class="type">'a <a href="Js_array.html#TYPEt">t</a> -> string</code></pre>
<pre><span id="VALevery"><span class="keyword">val</span> every</span> : <code class="type">('a -> bool) -> 'a <a href="Js_array.html#TYPEt">t</a> -> bool</code></pre>
<pre><span id="VALeveryi"><span class="keyword">val</span> everyi</span> : <code class="type">('a -> int -> bool) -> 'a <a href="Js_array.html#TYPEt">t</a> -> bool</code></pre>
<pre><span id="VALfilter"><span class="keyword">val</span> filter</span> : <code class="type">('a -> bool) -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre><div class="info ">
                    <div class="not-examples">
                    should we use <code class="code">bool</code> or <code class="code">boolan</code> seems they are intechangeable here<br>
 
                    </div>
                    
                    </div>

                  
<pre><span id="VALfilteri"><span class="keyword">val</span> filteri</span> : <code class="type">('a -> int -> bool) -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type">('a -> bool) -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a option</code></pre>
<pre><span id="VALfindi"><span class="keyword">val</span> findi</span> : <code class="type">('a -> int -> bool) -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'a option</code></pre><div class="info ">
                    <div class="not-examples">
                    ES2015<br>
 
                    </div>
                    
                    </div>

                  <br>
ES2015<br>

<pre><span id="VALfindIndex"><span class="keyword">val</span> findIndex</span> : <code class="type">('a -> bool) -> 'a <a href="Js_array.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALfindIndexi"><span class="keyword">val</span> findIndexi</span> : <code class="type">('a -> int -> bool) -> 'a <a href="Js_array.html#TYPEt">t</a> -> int</code></pre><div class="info ">
                    <div class="not-examples">
                    ES2015<br>
 
                    </div>
                    
                    </div>

                  <br>
ES2015<br>

<pre><span id="VALforEach"><span class="keyword">val</span> forEach</span> : <code class="type">('a -> unit) -> 'a <a href="Js_array.html#TYPEt">t</a> -> unit</code></pre>
<pre><span id="VALforEachi"><span class="keyword">val</span> forEachi</span> : <code class="type">('a -> int -> unit) -> 'a <a href="Js_array.html#TYPEt">t</a> -> unit</code></pre>
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">('a -> 'b) -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'b <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALmapi"><span class="keyword">val</span> mapi</span> : <code class="type">('a -> int -> 'b) -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'b <a href="Js_array.html#TYPEt">t</a></code></pre>
<pre><span id="VALreduce"><span class="keyword">val</span> reduce</span> : <code class="type">('b -> 'a -> 'b) -> 'b -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'b</code></pre>
<pre><span id="VALreducei"><span class="keyword">val</span> reducei</span> : <code class="type">('b -> 'a -> int -> 'b) -> 'b -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'b</code></pre>
<pre><span id="VALreduceRight"><span class="keyword">val</span> reduceRight</span> : <code class="type">('b -> 'a -> 'b) -> 'b -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'b</code></pre>
<pre><span id="VALreduceRighti"><span class="keyword">val</span> reduceRighti</span> : <code class="type">('b -> 'a -> int -> 'b) -> 'b -> 'a <a href="Js_array.html#TYPEt">t</a> -> 'b</code></pre>
<pre><span id="VALsome"><span class="keyword">val</span> some</span> : <code class="type">('a -> bool) -> 'a <a href="Js_array.html#TYPEt">t</a> -> bool</code></pre>
<pre><span id="VALsomei"><span class="keyword">val</span> somei</span> : <code class="type">('a -> int -> bool) -> 'a <a href="Js_array.html#TYPEt">t</a> -> bool</code></pre>
<pre><span id="VALunsafe_get"><span class="keyword">val</span> unsafe_get</span> : <code class="type">'a array -> int -> 'a</code></pre>
<pre><span id="VALunsafe_set"><span class="keyword">val</span> unsafe_set</span> : <code class="type">'a array -> int -> 'a -> unit</code></pre></body></html>