UNPKG

19.8 kBHTMLView Raw
1<!doctype html>
2<html class="default no-js">
3<head>
4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <title>$ | @nofrills/console</title>
7 <meta name="description" content="">
8 <meta name="viewport" content="width=device-width, initial-scale=1">
9 <link rel="stylesheet" href="../assets/css/main.css">
10</head>
11<body>
12<header>
13 <div class="tsd-page-toolbar">
14 <div class="container">
15 <div class="table-wrap">
16 <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17 <div class="field">
18 <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19 <input id="tsd-search-field" type="text" />
20 </div>
21 <ul class="results">
22 <li class="state loading">Preparing search index...</li>
23 <li class="state failure">The search index is not available</li>
24 </ul>
25 <a href="../index.html" class="title">@nofrills/console</a>
26 </div>
27 <div class="table-cell" id="tsd-widgets">
28 <div id="tsd-filter">
29 <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30 <div class="tsd-filter-group">
31 <div class="tsd-select" id="tsd-filter-visibility">
32 <span class="tsd-select-label">All</span>
33 <ul class="tsd-select-list">
34 <li data-value="public">Public</li>
35 <li data-value="protected">Public/Protected</li>
36 <li data-value="private" class="selected">All</li>
37 </ul>
38 </div>
39 <input type="checkbox" id="tsd-filter-inherited" checked />
40 <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41 <input type="checkbox" id="tsd-filter-externals" checked />
42 <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43 <input type="checkbox" id="tsd-filter-only-exported" />
44 <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45 </div>
46 </div>
47 <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48 </div>
49 </div>
50 </div>
51 </div>
52 <div class="tsd-page-title">
53 <div class="container">
54 <ul class="tsd-breadcrumb">
55 <li>
56 <a href="../globals.html">Globals</a>
57 </li>
58 <li>
59 <a href="../modules/_types_src_index_.html">&quot;types/src/index&quot;</a>
60 </li>
61 <li>
62 <a href="_types_src_index_._.html">$</a>
63 </li>
64 </ul>
65 <h1>Class $</h1>
66 </div>
67 </div>
68</header>
69<div class="container container-main">
70 <div class="row">
71 <div class="col-8 col-content">
72 <section class="tsd-panel tsd-hierarchy">
73 <h3>Hierarchy</h3>
74 <ul class="tsd-hierarchy">
75 <li>
76 <span class="target">$</span>
77 </li>
78 </ul>
79 </section>
80 <section class="tsd-panel-group tsd-index-group">
81 <h2>Index</h2>
82 <section class="tsd-panel tsd-index-panel">
83 <div class="tsd-index-content">
84 <section class="tsd-index-section tsd-is-external tsd-is-not-exported">
85 <h3>Properties</h3>
86 <ul class="tsd-index-list">
87 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported"><a href="_types_src_index_._.html#maxdate" class="tsd-kind-icon">Max<wbr>Date</a></li>
88 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported"><a href="_types_src_index_._.html#mindate" class="tsd-kind-icon">Min<wbr>Date</a></li>
89 </ul>
90 </section>
91 <section class="tsd-index-section tsd-is-external tsd-is-not-exported">
92 <h3>Methods</h3>
93 <ul class="tsd-index-list">
94 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported"><a href="_types_src_index_._.html#bounded" class="tsd-kind-icon">bounded</a></li>
95 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported"><a href="_types_src_index_._.html#clamped" class="tsd-kind-icon">clamped</a></li>
96 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported"><a href="_types_src_index_._.html#consumed" class="tsd-kind-icon">consumed</a></li>
97 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported"><a href="_types_src_index_._.html#timestamp" class="tsd-kind-icon">timestamp</a></li>
98 </ul>
99 </section>
100 </div>
101 </section>
102 </section>
103 <section class="tsd-panel-group tsd-member-group tsd-is-external tsd-is-not-exported">
104 <h2>Properties</h2>
105 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
106 <a name="maxdate" class="tsd-anchor"></a>
107 <h3><span class="tsd-flag ts-flagStatic">Static</span> Max<wbr>Date</h3>
108 <div class="tsd-signature tsd-kind-icon">Max<wbr>Date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol"> =&nbsp;new Date(&#x27;2038-01-19 03:14:07&#x27;)</span></div>
109 <aside class="tsd-sources">
110 <ul>
111 <li>Defined in <a href="https://github.com/nativecode-dev/nofrills/blob/e46d61d/packages/types/src/index.ts#L21">types/src/index.ts:21</a></li>
112 </ul>
113 </aside>
114 </section>
115 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
116 <a name="mindate" class="tsd-anchor"></a>
117 <h3><span class="tsd-flag ts-flagStatic">Static</span> Min<wbr>Date</h3>
118 <div class="tsd-signature tsd-kind-icon">Min<wbr>Date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol"> =&nbsp;new Date(&#x27;1970-01-01 00:00:01&#x27;)</span></div>
119 <aside class="tsd-sources">
120 <ul>
121 <li>Defined in <a href="https://github.com/nativecode-dev/nofrills/blob/e46d61d/packages/types/src/index.ts#L23">types/src/index.ts:23</a></li>
122 </ul>
123 </aside>
124 </section>
125 </section>
126 <section class="tsd-panel-group tsd-member-group tsd-is-external tsd-is-not-exported">
127 <h2>Methods</h2>
128 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
129 <a name="bounded" class="tsd-anchor"></a>
130 <h3><span class="tsd-flag ts-flagStatic">Static</span> bounded</h3>
131 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
132 <li class="tsd-signature tsd-kind-icon">bounded<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, props<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_types_src_typeproperties_.typeproperties.html" class="tsd-signature-type">TypeProperties</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
133 </ul>
134 <ul class="tsd-descriptions">
135 <li class="tsd-description">
136 <aside class="tsd-sources">
137 <ul>
138 <li>Defined in <a href="https://github.com/nativecode-dev/nofrills/blob/e46d61d/packages/types/src/index.ts#L25">types/src/index.ts:25</a></li>
139 </ul>
140 </aside>
141 <h4 class="tsd-parameters-title">Parameters</h4>
142 <ul class="tsd-parameters">
143 <li>
144 <h5>value: <span class="tsd-signature-type">number</span></h5>
145 </li>
146 <li>
147 <h5><span class="tsd-flag ts-flagOptional">Optional</span> props: <a href="../interfaces/_types_src_typeproperties_.typeproperties.html" class="tsd-signature-type">TypeProperties</a></h5>
148 </li>
149 </ul>
150 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
151 </li>
152 </ul>
153 </section>
154 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
155 <a name="clamped" class="tsd-anchor"></a>
156 <h3><span class="tsd-flag ts-flagStatic">Static</span> clamped</h3>
157 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
158 <li class="tsd-signature tsd-kind-icon">clamped<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, props<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_types_src_typeproperties_.typeproperties.html" class="tsd-signature-type">TypeProperties</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
159 </ul>
160 <ul class="tsd-descriptions">
161 <li class="tsd-description">
162 <aside class="tsd-sources">
163 <ul>
164 <li>Defined in <a href="https://github.com/nativecode-dev/nofrills/blob/e46d61d/packages/types/src/index.ts#L29">types/src/index.ts:29</a></li>
165 </ul>
166 </aside>
167 <h4 class="tsd-parameters-title">Parameters</h4>
168 <ul class="tsd-parameters">
169 <li>
170 <h5>value: <span class="tsd-signature-type">number</span></h5>
171 </li>
172 <li>
173 <h5><span class="tsd-flag ts-flagOptional">Optional</span> props: <a href="../interfaces/_types_src_typeproperties_.typeproperties.html" class="tsd-signature-type">TypeProperties</a></h5>
174 </li>
175 </ul>
176 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
177 </li>
178 </ul>
179 </section>
180 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
181 <a name="consumed" class="tsd-anchor"></a>
182 <h3><span class="tsd-flag ts-flagStatic">Static</span> consumed</h3>
183 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
184 <li class="tsd-signature tsd-kind-icon">consumed<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, props<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_types_src_typeproperties_.typeproperties.html" class="tsd-signature-type">TypeProperties</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
185 </ul>
186 <ul class="tsd-descriptions">
187 <li class="tsd-description">
188 <aside class="tsd-sources">
189 <ul>
190 <li>Defined in <a href="https://github.com/nativecode-dev/nofrills/blob/e46d61d/packages/types/src/index.ts#L41">types/src/index.ts:41</a></li>
191 </ul>
192 </aside>
193 <h4 class="tsd-parameters-title">Parameters</h4>
194 <ul class="tsd-parameters">
195 <li>
196 <h5>value: <span class="tsd-signature-type">any</span></h5>
197 </li>
198 <li>
199 <h5><span class="tsd-flag ts-flagOptional">Optional</span> props: <a href="../interfaces/_types_src_typeproperties_.typeproperties.html" class="tsd-signature-type">TypeProperties</a></h5>
200 </li>
201 </ul>
202 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
203 </li>
204 </ul>
205 </section>
206 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
207 <a name="timestamp" class="tsd-anchor"></a>
208 <h3><span class="tsd-flag ts-flagStatic">Static</span> timestamp</h3>
209 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
210 <li class="tsd-signature tsd-kind-icon">timestamp<span class="tsd-signature-symbol">(</span>timestamp<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
211 </ul>
212 <ul class="tsd-descriptions">
213 <li class="tsd-description">
214 <aside class="tsd-sources">
215 <ul>
216 <li>Defined in <a href="https://github.com/nativecode-dev/nofrills/blob/e46d61d/packages/types/src/index.ts#L45">types/src/index.ts:45</a></li>
217 </ul>
218 </aside>
219 <h4 class="tsd-parameters-title">Parameters</h4>
220 <ul class="tsd-parameters">
221 <li>
222 <h5>timestamp: <span class="tsd-signature-type">number</span></h5>
223 </li>
224 </ul>
225 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
226 </li>
227 </ul>
228 </section>
229 </section>
230 </div>
231 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
232 <nav class="tsd-navigation primary">
233 <ul>
234 <li class="globals ">
235 <a href="../globals.html"><em>Globals</em></a>
236 </li>
237 <li class="current tsd-kind-external-module tsd-is-external">
238 <a href="../modules/_types_src_index_.html">"types/src/index"</a>
239 </li>
240 </ul>
241 </nav>
242 <nav class="tsd-navigation secondary menu-sticky">
243 <ul class="before-current">
244 </ul>
245 <ul class="current">
246 <li class="current tsd-kind-class tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
247 <a href="_types_src_index_._.html" class="tsd-kind-icon">$</a>
248 <ul>
249 <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
250 <a href="_types_src_index_._.html#maxdate" class="tsd-kind-icon">Max<wbr>Date</a>
251 </li>
252 <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
253 <a href="_types_src_index_._.html#mindate" class="tsd-kind-icon">Min<wbr>Date</a>
254 </li>
255 <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
256 <a href="_types_src_index_._.html#bounded" class="tsd-kind-icon">bounded</a>
257 </li>
258 <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
259 <a href="_types_src_index_._.html#clamped" class="tsd-kind-icon">clamped</a>
260 </li>
261 <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
262 <a href="_types_src_index_._.html#consumed" class="tsd-kind-icon">consumed</a>
263 </li>
264 <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external tsd-is-not-exported">
265 <a href="_types_src_index_._.html#timestamp" class="tsd-kind-icon">timestamp</a>
266 </li>
267 </ul>
268 </li>
269 </ul>
270 <ul class="after-current">
271 <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-external tsd-is-not-exported">
272 <a href="../modules/_types_src_index_.html#phone" class="tsd-kind-icon">phone</a>
273 </li>
274 </ul>
275 </nav>
276 </div>
277 </div>
278</div>
279<footer class="with-border-bottom">
280 <div class="container">
281 <h2>Legend</h2>
282 <div class="tsd-legend-group">
283 <ul class="tsd-legend">
284 <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
285 <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
286 <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
287 <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
288 <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
289 <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
290 <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
291 </ul>
292 <ul class="tsd-legend">
293 <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
294 <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
295 <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
296 <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
297 </ul>
298 <ul class="tsd-legend">
299 <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
300 <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
301 <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
302 <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
303 <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
304 <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
305 </ul>
306 <ul class="tsd-legend">
307 <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
308 <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
309 <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
310 <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
311 <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
312 <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
313 <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
314 </ul>
315 <ul class="tsd-legend">
316 <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
317 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
318 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
319 <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
320 </ul>
321 <ul class="tsd-legend">
322 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
323 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
324 <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
325 </ul>
326 <ul class="tsd-legend">
327 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
328 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
329 <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
330 </ul>
331 <ul class="tsd-legend">
332 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
333 <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
334 </ul>
335 </div>
336 </div>
337</footer>
338<div class="container tsd-generator">
339 <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
340</div>
341<div class="overlay"></div>
342<script src="../assets/js/main.js"></script>
343<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
344</body>
345</html>
\No newline at end of file