forked from rescript-lang/rescript
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathJs.Dict.html
207 lines (151 loc) · 9.92 KB
/
Js.Dict.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<!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.Date.html"><link rel="next" href="Js.Global.html">
<title> Js.Dict </title></head>
<body>
<nav class="module-index"><ul><li><a href="Bs.html">Bs</a></li>
<li><a href="Bs_dyn.html">Bs_dyn</a></li>
<li><a href="Bs_dyn_lib.html">Bs_dyn_lib</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_boolean.html">Js_boolean</a></li>
<li><a href="Js_cast.html">Js_cast</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_int64.html">Js_int64</a></li>
<li><a href="Js_internal.html">Js_internal</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_math.html">Js_math</a></li>
<li><a href="Js_nativeint.html">Js_nativeint</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_primitive.html">Js_primitive</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_unsafe.html">Js_unsafe</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.Date.html" title="Js.Date">Previous</a>
<a class="up" href="Js.html" title="Js">Up</a>
<a class="post" href="Js.Global.html" title="Js.Global">Next</a>
</div>
<h1>Module <a href="type_Js.Dict.html">Js.Dict</a></h1>
<pre><span class="keyword">module</span> Dict: <code class="type"><a href="Js_dict.html">Js_dict</a></code></pre><div class="info module top">
<div class="not-examples">
Provide utilities for JS dictionary object<br>
</div>
</div>
<hr width="100%">
<div class="type-declaration">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'a</code> t</span> </pre>
</div>
<div class="info ">
<div class="not-examples">
Dictionary type (ie an '{ }' JS object). However it is restricted
to hold a single type; therefore values must have the same type.
<p>
This Dictionary type is mostly use with the <code class="code">Js_json.t</code> type.<br>
</div>
</div>
<div class="type-declaration">
<pre><span id="TYPEkey"><span class="keyword">type</span> <code class="type"></code>key</span> = <code class="type">string</code> </pre>
</div>
<div class="info ">
<div class="not-examples">
Key type<br>
</div>
</div>
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type">'a <a href="Js_dict.html#TYPEt">t</a> -> <a href="Js_dict.html#TYPEkey">key</a> -> 'a option</code></pre><div class="info ">
<div class="not-examples">
<code class="code">get dict key</code> returns <code class="code">None</code> if the <code class="code">key</code> is not found in the
dictionary, <code class="code">Some value</code> otherwise<br>
</div>
</div>
<pre><span id="VALunsafeGet"><span class="keyword">val</span> unsafeGet</span> : <code class="type">'a <a href="Js_dict.html#TYPEt">t</a> -> <a href="Js_dict.html#TYPEkey">key</a> -> 'a</code></pre><div class="info ">
<div class="not-examples">
<code class="code">unsafeGet dict key</code> return the value if the <code class="code">key</code> exists,
otherwise an <b>undefined</b> value is returned. Must be used only
when the existence of a key is certain. (i.e. when having called <code class="code">keys</code>
function previously.<br>
</div>
<div class="examples">
<pre class="example"> <pre class="codepre"><code class="code">Array.iter (fun key -> Js.log (Js_dict.unsafeGet dic key)) (Js_dict.keys dict)
</code></pre> </pre>
</div>
</div>
<pre><span id="VALset"><span class="keyword">val</span> set</span> : <code class="type">'a <a href="Js_dict.html#TYPEt">t</a> -> <a href="Js_dict.html#TYPEkey">key</a> -> 'a -> unit</code></pre><div class="info ">
<div class="not-examples">
<code class="code">set dict key value</code> sets the <code class="code">key</code>/<code class="code">value</code> in <code class="code">dict</code><br>
</div>
</div>
<pre><span id="VALkeys"><span class="keyword">val</span> keys</span> : <code class="type">'a <a href="Js_dict.html#TYPEt">t</a> -> string array</code></pre><div class="info ">
<div class="not-examples">
<code class="code">keys dict</code> returns all the keys in the dictionary <code class="code">dict</code><br>
</div>
</div>
<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 ">
<div class="not-examples">
<code class="code">empty ()</code> returns en empty dictionary<br>
</div>
</div>
<pre><span id="VALunsafeDeleteKey"><span class="keyword">val</span> unsafeDeleteKey</span> : <code class="type">(string <a href="Js_dict.html#TYPEt">t</a> -> string -> unit [@bs])</code></pre><div class="info ">
<div class="not-examples">
Experimental internal funciton<br>
</div>
</div>
<pre><span id="VALentries"><span class="keyword">val</span> entries</span> : <code class="type">'a <a href="Js_dict.html#TYPEt">t</a> -> (<a href="Js_dict.html#TYPEkey">key</a> * 'a) array</code></pre><div class="info ">
<div class="not-examples">
<code class="code">entries dict</code> returns the key value pairs in <code class="code">dict</code> (ES2017)<br>
</div>
</div>
<pre><span id="VALvalues"><span class="keyword">val</span> values</span> : <code class="type">'a <a href="Js_dict.html#TYPEt">t</a> -> 'a array</code></pre><div class="info ">
<div class="not-examples">
<code class="code">entries dict</code> returns the values in <code class="code">dict</code> (ES2017)<br>
</div>
</div>
<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 ">
<div class="not-examples">
<code class="code">fromList entries</code> creates a new dictionary using with containing each
<code class="code">(key, value)</code> pair in <code class="code">entries</code><br>
</div>
</div>
<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 ">
<div class="not-examples">
<code class="code">fromArray entries</code> creates a new dictionary using with containing each
<code class="code">(key, value)</code> pair in <code class="code">entries</code><br>
</div>
</div>
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">('a -> 'b [@bs]) -> 'a <a href="Js_dict.html#TYPEt">t</a> -> 'b <a href="Js_dict.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">map f dict</code> maps <code class="code">dict</code> to a new dictionary with the same keys,
using <code class="code">f</code> to map each value<br>
</div>
</div>
</body></html>