Skip to content

Commit a35ac4e

Browse files
zploskeyzploskey
committed
Regenerate API docs
Signed-off-by: Zach Ploskey <zach@ploskey.com>
1 parent a96bbd1 commit a35ac4e

40 files changed

+148
-378
lines changed

‎docs/api/Bs.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ <h1>Module <a href="type_Bs.html">Bs</a></h1>
5959

6060
<pre><span class="keyword">module</span> Bs: <code class="code">sig</code> <a href="Bs.html">..</a> <code class="code">end</code></pre><div class="info module top">
6161
<div class="not-examples">
62-
place holder for BuckleScript datastructures<br>
62+
Placeholder for BuckleScript data structures<br>
6363

6464
</div>
6565

‎docs/api/Js.Boolean.html

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

6161
<pre><span class="keyword">module</span> Boolean: <code class="type"><a href="Js_boolean.html">Js_boolean</a></code></pre><div class="info module top">
6262
<div class="not-examples">
63-
Provide utilties for <a href="Js.html#TYPEboolean"><code class="code">Js.boolean</code></a><br>
63+
Provide utilities for <a href="Js.html#TYPEboolean"><code class="code">Js.boolean</code></a><br>
6464

6565
</div>
6666

‎docs/api/Js.Dict.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ <h1>Module <a href="type_Js.Dict.html">Js.Dict</a></h1>
7676
to hold a single type; therefore values must have the same type.
7777
<p>
7878

79-
This Dictionary type is mostly use with the <code class="code">Js_json.t</code> type.<br>
79+
This Dictionary type is mostly used with the <code class="code">Js_json.t</code> type.<br>
8080

8181
</div>
8282

@@ -141,7 +141,7 @@ <h1>Module <a href="type_Js.Dict.html">Js.Dict</a></h1>
141141

142142
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type">unit -> 'a <a href="Js_dict.html#TYPEt">t</a></code></pre><div class="info ">
143143
<div class="not-examples">
144-
<code class="code">empty ()</code> returns en empty dictionary<br>
144+
<code class="code">empty ()</code> returns an empty dictionary<br>
145145

146146
</div>
147147

@@ -177,7 +177,7 @@ <h1>Module <a href="type_Js.Dict.html">Js.Dict</a></h1>
177177

178178
<pre><span id="VALfromList"><span class="keyword">val</span> fromList</span> : <code class="type">(<a href="Js_dict.html#TYPEkey">key</a> * 'a) list -> 'a <a href="Js_dict.html#TYPEt">t</a></code></pre><div class="info ">
179179
<div class="not-examples">
180-
<code class="code">fromList entries</code> creates a new dictionary using with containing each
180+
<code class="code">fromList entries</code> creates a new dictionary containing each
181181
<code class="code">(key, value)</code> pair in <code class="code">entries</code><br>
182182

183183
</div>
@@ -187,7 +187,7 @@ <h1>Module <a href="type_Js.Dict.html">Js.Dict</a></h1>
187187

188188
<pre><span id="VALfromArray"><span class="keyword">val</span> fromArray</span> : <code class="type">(<a href="Js_dict.html#TYPEkey">key</a> * 'a) array -> 'a <a href="Js_dict.html#TYPEt">t</a></code></pre><div class="info ">
189189
<div class="not-examples">
190-
<code class="code">fromArray entries</code> creates a new dictionary using with containing each
190+
<code class="code">fromArray entries</code> creates a new dictionary containing each
191191
<code class="code">(key, value)</code> pair in <code class="code">entries</code><br>
192192

193193
</div>

‎docs/api/Js.Float.html

-96
Original file line numberDiff line numberDiff line change
@@ -362,100 +362,4 @@ <h1>Module <a href="type_Js.Float.html">Js.Float</a></h1>
362362
</div>
363363
</div>
364364

365-
366-
<pre><span id="VALnan"><span class="keyword">val</span> nan</span> : <code class="type">float</code></pre><div class="info ">
367-
<div class="not-examples">
368-
<div class="warning">
369-
<span class="label">Deprecated.</span>
370-
Use <a href="Js_float.html#VAL_NaN"><code class="code">Js_float._NaN</code></a> instead
371-
</div>
372-
373-
</div>
374-
375-
</div>
376-
377-
378-
<pre><span id="VALto_exponential"><span class="keyword">val</span> to_exponential</span> : <code class="type">float -> prec:int -> string</code></pre><div class="info ">
379-
<div class="not-examples">
380-
<div class="warning">
381-
<span class="label">Deprecated.</span>
382-
Use <a href="Js_float.html#VALtoExponential"><code class="code">Js_float.toExponential</code></a> instead
383-
</div>
384-
385-
</div>
386-
387-
</div>
388-
389-
390-
<pre><span id="VALexp"><span class="keyword">val</span> exp</span> : <code class="type">float -> float</code></pre><div class="info ">
391-
<div class="not-examples">
392-
<div class="warning">
393-
<span class="label">Deprecated.</span>
394-
Use <code class="code">exp</code> in <a href="Js.Math.html"><code class="code">Js.Math</code></a> instead
395-
</div>
396-
397-
</div>
398-
399-
</div>
400-
401-
402-
<pre><span id="VALlog"><span class="keyword">val</span> log</span> : <code class="type">float -> float</code></pre><div class="info ">
403-
<div class="not-examples">
404-
<div class="warning">
405-
<span class="label">Deprecated.</span>
406-
Use <code class="code">log</code> in <a href="Js.Math.html"><code class="code">Js.Math</code></a> instead
407-
</div>
408-
409-
</div>
410-
411-
</div>
412-
413-
414-
<pre><span id="VALlog2"><span class="keyword">val</span> log2</span> : <code class="type">float</code></pre><div class="info ">
415-
<div class="not-examples">
416-
<div class="warning">
417-
<span class="label">Deprecated.</span>
418-
Use <code class="code">_LN2</code> in <a href="Js.Math.html"><code class="code">Js.Math</code></a> instead
419-
</div>
420-
421-
</div>
422-
423-
</div>
424-
425-
426-
<pre><span id="VALmax"><span class="keyword">val</span> max</span> : <code class="type">float -> float -> float</code></pre><div class="info ">
427-
<div class="not-examples">
428-
<div class="warning">
429-
<span class="label">Deprecated.</span>
430-
Use <code class="code">max_float</code> in <a href="Js.Math.html"><code class="code">Js.Math</code></a> instead
431-
</div>
432-
433-
</div>
434-
435-
</div>
436-
437-
438-
<pre><span id="VALrandom"><span class="keyword">val</span> random</span> : <code class="type">unit -> float</code></pre><div class="info ">
439-
<div class="not-examples">
440-
<div class="warning">
441-
<span class="label">Deprecated.</span>
442-
Use <code class="code">random</code> in <a href="Js.Math.html"><code class="code">Js.Math</code></a> instead
443-
</div>
444-
445-
</div>
446-
447-
</div>
448-
449-
450-
<pre><span id="VALof_any"><span class="keyword">val</span> of_any</span> : <code class="type">'a -> float</code></pre><div class="info ">
451-
<div class="not-examples">
452-
<div class="warning">
453-
<span class="label">Deprecated.</span>
454-
This is an unsafe function, please use a proper conversion function
455-
</div>
456-
457-
</div>
458-
459-
</div>
460-
461365
</body></html>

‎docs/api/Js.Json.html

-15
Original file line numberDiff line numberDiff line change
@@ -190,19 +190,6 @@ <h1>Module <a href="type_Js.Json.html">Js.Json</a></h1>
190190

191191

192192
<pre><span id="VALclassify"><span class="keyword">val</span> classify</span> : <code class="type"><a href="Js_json.html#TYPEt">t</a> -> <a href="Js_json.html#TYPEtagged_t">tagged_t</a></code></pre>
193-
<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 ">
194-
<div class="not-examples">
195-
<div class="warning">
196-
<span class="label">Deprecated.</span>
197-
Use <a href="Js_json.html#VALclassify"><code class="code">Js_json.classify</code></a> instead
198-
</div>
199-
<code class="code">reifyType v</code> returns both type and underlying value<br>
200-
201-
</div>
202-
203-
</div>
204-
205-
206193
<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 ">
207194
<div class="not-examples">
208195
<code class="code">test v kind</code> returns true if <code class="code">v</code> is of <code class="code">kind</code><br>
@@ -317,7 +304,6 @@ <h1>Module <a href="type_Js.Json.html">Js.Json</a></h1>
317304
</div>
318305

319306

320-
<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>
321307
<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 ">
322308
<div class="not-examples">
323309
<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>
@@ -363,7 +349,6 @@ <h1>Module <a href="type_Js.Json.html">Js.Json</a></h1>
363349
</div>
364350

365351

366-
<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>
367352
<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 ">
368353
<div class="not-examples">
369354
<code class="code">parse s</code> parses the string <code class="code">s</code> into a JSON data structure

‎docs/api/Js.List.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ <h1>Module <a href="type_Js.List.html">Js.List</a></h1>
6060

6161
<pre><span class="keyword">module</span> List: <code class="type"><a href="Js_list.html">Js_list</a></code></pre><div class="info module top">
6262
<div class="not-examples">
63-
Provide utilties for list<br>
63+
Provide utilities for list<br>
6464

6565
</div>
6666

@@ -108,4 +108,5 @@ <h1>Module <a href="type_Js.List.html">Js.List</a></h1>
108108
<pre><span id="VALfilterMap"><span class="keyword">val</span> filterMap</span> : <code class="type">('a -> 'b option [@bs]) -> 'a <a href="Js_list.html#TYPEt">t</a> -> 'b <a href="Js_list.html#TYPEt">t</a></code></pre>
109109
<pre><span id="VALcountBy"><span class="keyword">val</span> countBy</span> : <code class="type">('a -> bool [@bs]) -> 'a list -> int</code></pre>
110110
<pre><span id="VALinit"><span class="keyword">val</span> init</span> : <code class="type">int -> (int -> 'a [@bs]) -> 'a <a href="Js_list.html#TYPEt">t</a></code></pre>
111+
<pre><span id="VALtoVector"><span class="keyword">val</span> toVector</span> : <code class="type">'a <a href="Js_list.html#TYPEt">t</a> -> 'a <a href="Js_vector.html#TYPEt">Js_vector.t</a></code></pre>
111112
<pre><span id="VALequal"><span class="keyword">val</span> equal</span> : <code class="type">('a -> 'a -> bool [@bs]) -> 'a list -> 'a list -> bool</code></pre></body></html>

‎docs/api/Js.Null.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ <h1>Module <a href="type_Js.Null.html">Js.Null</a></h1>
5959

6060
<pre><span class="keyword">module</span> Null: <code class="type"><a href="Js_null.html">Js_null</a></code></pre><div class="info module top">
6161
<div class="not-examples">
62-
Provide utilities arond <code class="code">'a null</code><br>
62+
Provide utilities around <code class="code">'a null</code><br>
6363

6464
</div>
6565

‎docs/api/Js.Nullable.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ <h1>Module <a href="type_Js.Nullable.html">Js.Nullable</a></h1>
6060

6161
<pre><span class="keyword">module</span> Nullable: <code class="type"><a href="Js_null_undefined.html">Js_null_undefined</a></code></pre><div class="info module top">
6262
<div class="not-examples">
63-
Provide utilities arond <a href="Js.html#TYPEnull_undefined"><code class="code">Js.null_undefined</code></a><br>
63+
Provide utilities around <a href="Js.html#TYPEnull_undefined"><code class="code">Js.null_undefined</code></a><br>
6464

6565
</div>
6666

‎docs/api/Js.Option.html

+1
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ <h1>Module <a href="type_Js.Option.html">Js.Option</a></h1>
8080
<pre><span id="VALequal"><span class="keyword">val</span> equal</span> : <code class="type">('a -> 'b -> bool [@bs]) -> 'a option -> 'b option -> bool</code></pre>
8181
<pre><span id="VALandThen"><span class="keyword">val</span> andThen</span> : <code class="type">('a -> 'b option [@bs]) -> 'a option -> 'b option</code></pre>
8282
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">('a -> 'b [@bs]) -> 'a option -> 'b option</code></pre>
83+
<pre><span id="VALgetWithDefault"><span class="keyword">val</span> getWithDefault</span> : <code class="type">'a -> 'a option -> 'a</code></pre>
8384
<pre><span id="VALdefault"><span class="keyword">val</span> default</span> : <code class="type">'a -> 'a option -> 'a</code></pre>
8485
<pre><span id="VALfilter"><span class="keyword">val</span> filter</span> : <code class="type">('a -> bool [@bs]) -> 'a option -> 'a option</code></pre>
8586
<pre><span id="VALfirstSome"><span class="keyword">val</span> firstSome</span> : <code class="type">'a option -> 'a option -> 'a option</code></pre></body></html>

‎docs/api/Js.Re.html

+14-5
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,15 @@ <h1>Module <a href="type_Js.Re.html">Js.Re</a></h1>
9292

9393

9494

95+
<pre><span id="VALcaptures"><span class="keyword">val</span> captures</span> : <code class="type"><a href="Js_re.html#TYPEresult">result</a> -> string <a href="Js.html#TYPEnullable">Js.nullable</a> array</code></pre><div class="info ">
96+
<div class="not-examples">
97+
an array of the match and captures, the first is the full match and the remaining are the substring captures<br>
98+
99+
</div>
100+
101+
</div>
102+
103+
95104
<pre><span id="VALmatches"><span class="keyword">val</span> matches</span> : <code class="type"><a href="Js_re.html#TYPEresult">result</a> -> string array</code></pre><div class="info ">
96105
<div class="not-examples">
97106
an array of the matches, the first is the full match and the remaining are the substring matches<br>
@@ -132,10 +141,10 @@ <h1>Module <a href="type_Js.Re.html">Js.Re</a></h1>
132141
<pre class="example"> <pre class="codepre"><code class="code">(* A function that extracts the content of the first element with the given tag *)
133142

134143
let contentOf tag xmlString =
135-
Js.Re.fromString ("&lt;" ^ tag ^ "&gt;(.|\n)*?&lt;\/" ^ tag ^"&gt;")
144+
Js.Re.fromString ("&lt;" ^ tag ^ "&gt;(.*?)&lt;\\/" ^ tag ^"&gt;")
136145
|&gt; Js.Re.exec xmlString
137146
|&gt; function
138-
| Some result -&gt; Some (Js.Re.matches result).(1)
147+
| Some result -&gt; Js.Nullable.to_opt (Js.Re.captures result).(1)
139148
| None -&gt; None
140149
</code></pre> </pre>
141150
</div>
@@ -213,9 +222,9 @@ <h1>Module <a href="type_Js.Re.html">Js.Re</a></h1>
213222
match re |&gt; Js.Re.exec str with
214223
| None -&gt; break := true
215224
| Some result -&gt;
216-
let match_ = (Js.Re.matches result).(0) in
217-
let next = string_of_int (Js.Re.lastIndex re) in
218-
Js.log ("Found " ^ match_ ^ ". Next match starts at " ^ next)
225+
Js.Nullable.iter (Js.Re.captures result).(0) ((fun match_ -&gt;
226+
let next = string_of_int (Js.Re.lastIndex re) in
227+
Js.log ("Found " ^ match_ ^ ". Next match starts at " ^ next)))
219228
done
220229
</code></pre> </pre>
221230
</div>

‎docs/api/Js.Result.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ <h1>Module <a href="type_Js.Result.html">Js.Result</a></h1>
6060

6161
<pre><span class="keyword">module</span> Result: <code class="type"><a href="Js_result.html">Js_result</a></code></pre><div class="info module top">
6262
<div class="not-examples">
63-
definie the interface for result<br>
63+
Define the interface for result<br>
6464

6565
</div>
6666

‎docs/api/Js.Types.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ <h1>Module <a href="type_Js.Types.html">Js.Types</a></h1>
6060

6161
<pre><span class="keyword">module</span> Types: <code class="type"><a href="Js_types.html">Js_types</a></code></pre><div class="info module top">
6262
<div class="not-examples">
63-
Provide utilities for maninpulatig JS types<br>
63+
Provide utilities for manipulating JS types<br>
6464

6565
</div>
6666

0 commit comments

Comments
 (0)