UNPKG

21.3 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>TypeParser | @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_typeparser_.html">&quot;types/src/TypeParser&quot;</a>
60 </li>
61 <li>
62 <a href="_types_src_typeparser_.typeparser.html">TypeParser</a>
63 </li>
64 </ul>
65 <h1>Class TypeParser</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">TypeParser</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">
85 <h3>Methods</h3>
86 <ul class="tsd-index-list">
87 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_types_src_typeparser_.typeparser.html#deserialize" class="tsd-kind-icon">deserialize</a></li>
88 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external"><a href="_types_src_typeparser_.typeparser.html#materialize" class="tsd-kind-icon">materialize</a></li>
89 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external"><a href="_types_src_typeparser_.typeparser.html#parse" class="tsd-kind-icon">parse</a></li>
90 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external"><a href="_types_src_typeparser_.typeparser.html#properties" class="tsd-kind-icon">properties</a></li>
91 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_types_src_typeparser_.typeparser.html#serialize" class="tsd-kind-icon">serialize</a></li>
92 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external"><a href="_types_src_typeparser_.typeparser.html#typed" class="tsd-kind-icon">typed</a></li>
93 </ul>
94 </section>
95 </div>
96 </section>
97 </section>
98 <section class="tsd-panel-group tsd-member-group tsd-is-external">
99 <h2>Methods</h2>
100 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
101 <a name="deserialize" class="tsd-anchor"></a>
102 <h3><span class="tsd-flag ts-flagStatic">Static</span> deserialize</h3>
103 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
104 <li class="tsd-signature tsd-kind-icon">deserialize<span class="tsd-signature-symbol">(</span>typestr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_src_type_.type.html" class="tsd-signature-type">Type</a></li>
105 </ul>
106 <ul class="tsd-descriptions">
107 <li class="tsd-description">
108 <aside class="tsd-sources">
109 <ul>
110 <li>Defined in <a href="https://github.com/nativecode-dev/nofrills/blob/e46d61d/packages/types/src/TypeParser.ts#L6">types/src/TypeParser.ts:6</a></li>
111 </ul>
112 </aside>
113 <h4 class="tsd-parameters-title">Parameters</h4>
114 <ul class="tsd-parameters">
115 <li>
116 <h5>typestr: <span class="tsd-signature-type">string</span></h5>
117 </li>
118 </ul>
119 <h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_src_type_.type.html" class="tsd-signature-type">Type</a></h4>
120 </li>
121 </ul>
122 </section>
123 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external">
124 <a name="materialize" class="tsd-anchor"></a>
125 <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> materialize</h3>
126 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external">
127 <li class="tsd-signature tsd-kind-icon">materialize<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_types_src_type_.type.html" class="tsd-signature-type">Type</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_src_type_.type.html" class="tsd-signature-type">Type</a></li>
128 </ul>
129 <ul class="tsd-descriptions">
130 <li class="tsd-description">
131 <aside class="tsd-sources">
132 <ul>
133 <li>Defined in <a href="https://github.com/nativecode-dev/nofrills/blob/e46d61d/packages/types/src/TypeParser.ts#L33">types/src/TypeParser.ts:33</a></li>
134 </ul>
135 </aside>
136 <h4 class="tsd-parameters-title">Parameters</h4>
137 <ul class="tsd-parameters">
138 <li>
139 <h5>type: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_types_src_type_.type.html" class="tsd-signature-type">Type</a><span class="tsd-signature-symbol">&gt;</span></h5>
140 </li>
141 </ul>
142 <h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_src_type_.type.html" class="tsd-signature-type">Type</a></h4>
143 </li>
144 </ul>
145 </section>
146 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external">
147 <a name="parse" class="tsd-anchor"></a>
148 <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> parse</h3>
149 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external">
150 <li class="tsd-signature tsd-kind-icon">parse<span class="tsd-signature-symbol">(</span>typestr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_src_type_.type.html" class="tsd-signature-type">Type</a></li>
151 </ul>
152 <ul class="tsd-descriptions">
153 <li class="tsd-description">
154 <aside class="tsd-sources">
155 <ul>
156 <li>Defined in <a href="https://github.com/nativecode-dev/nofrills/blob/e46d61d/packages/types/src/TypeParser.ts#L38">types/src/TypeParser.ts:38</a></li>
157 </ul>
158 </aside>
159 <h4 class="tsd-parameters-title">Parameters</h4>
160 <ul class="tsd-parameters">
161 <li>
162 <h5>typestr: <span class="tsd-signature-type">string</span></h5>
163 </li>
164 </ul>
165 <h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_src_type_.type.html" class="tsd-signature-type">Type</a></h4>
166 </li>
167 </ul>
168 </section>
169 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external">
170 <a name="properties" class="tsd-anchor"></a>
171 <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> properties</h3>
172 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external">
173 <li class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_src_type_.type.html" class="tsd-signature-type">Type</a>, properties<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_src_typeproperties_.typeproperties.html" class="tsd-signature-type">TypeProperties</a></li>
174 </ul>
175 <ul class="tsd-descriptions">
176 <li class="tsd-description">
177 <aside class="tsd-sources">
178 <ul>
179 <li>Defined in <a href="https://github.com/nativecode-dev/nofrills/blob/e46d61d/packages/types/src/TypeParser.ts#L48">types/src/TypeParser.ts:48</a></li>
180 </ul>
181 </aside>
182 <h4 class="tsd-parameters-title">Parameters</h4>
183 <ul class="tsd-parameters">
184 <li>
185 <h5>type: <a href="../interfaces/_types_src_type_.type.html" class="tsd-signature-type">Type</a></h5>
186 </li>
187 <li>
188 <h5>properties: <span class="tsd-signature-type">string</span></h5>
189 </li>
190 </ul>
191 <h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_src_typeproperties_.typeproperties.html" class="tsd-signature-type">TypeProperties</a></h4>
192 </li>
193 </ul>
194 </section>
195 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
196 <a name="serialize" class="tsd-anchor"></a>
197 <h3><span class="tsd-flag ts-flagStatic">Static</span> serialize</h3>
198 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
199 <li class="tsd-signature tsd-kind-icon">serialize<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_types_src_type_.type.html" class="tsd-signature-type">Type</a><span class="tsd-signature-symbol">&gt;</span>, full<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
200 </ul>
201 <ul class="tsd-descriptions">
202 <li class="tsd-description">
203 <aside class="tsd-sources">
204 <ul>
205 <li>Defined in <a href="https://github.com/nativecode-dev/nofrills/blob/e46d61d/packages/types/src/TypeParser.ts#L10">types/src/TypeParser.ts:10</a></li>
206 </ul>
207 </aside>
208 <h4 class="tsd-parameters-title">Parameters</h4>
209 <ul class="tsd-parameters">
210 <li>
211 <h5>type: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_types_src_type_.type.html" class="tsd-signature-type">Type</a><span class="tsd-signature-symbol">&gt;</span></h5>
212 </li>
213 <li>
214 <h5><span class="tsd-flag ts-flagDefault value">Default value</span> full: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></h5>
215 </li>
216 </ul>
217 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
218 </li>
219 </ul>
220 </section>
221 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external">
222 <a name="typed" class="tsd-anchor"></a>
223 <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> typed</h3>
224 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external">
225 <li class="tsd-signature tsd-kind-icon">typed<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
226 </ul>
227 <ul class="tsd-descriptions">
228 <li class="tsd-description">
229 <aside class="tsd-sources">
230 <ul>
231 <li>Defined in <a href="https://github.com/nativecode-dev/nofrills/blob/e46d61d/packages/types/src/TypeParser.ts#L64">types/src/TypeParser.ts:64</a></li>
232 </ul>
233 </aside>
234 <h4 class="tsd-parameters-title">Parameters</h4>
235 <ul class="tsd-parameters">
236 <li>
237 <h5>value: <span class="tsd-signature-type">string</span></h5>
238 </li>
239 </ul>
240 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
241 </li>
242 </ul>
243 </section>
244 </section>
245 </div>
246 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
247 <nav class="tsd-navigation primary">
248 <ul>
249 <li class="globals ">
250 <a href="../globals.html"><em>Globals</em></a>
251 </li>
252 <li class="current tsd-kind-external-module tsd-is-external">
253 <a href="../modules/_types_src_typeparser_.html">"types/src/<wbr>Type<wbr>Parser"</a>
254 </li>
255 </ul>
256 </nav>
257 <nav class="tsd-navigation secondary menu-sticky">
258 <ul class="before-current">
259 </ul>
260 <ul class="current">
261 <li class="current tsd-kind-class tsd-parent-kind-external-module tsd-is-external">
262 <a href="_types_src_typeparser_.typeparser.html" class="tsd-kind-icon">Type<wbr>Parser</a>
263 <ul>
264 <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
265 <a href="_types_src_typeparser_.typeparser.html#deserialize" class="tsd-kind-icon">deserialize</a>
266 </li>
267 <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external">
268 <a href="_types_src_typeparser_.typeparser.html#materialize" class="tsd-kind-icon">materialize</a>
269 </li>
270 <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external">
271 <a href="_types_src_typeparser_.typeparser.html#parse" class="tsd-kind-icon">parse</a>
272 </li>
273 <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external">
274 <a href="_types_src_typeparser_.typeparser.html#properties" class="tsd-kind-icon">properties</a>
275 </li>
276 <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
277 <a href="_types_src_typeparser_.typeparser.html#serialize" class="tsd-kind-icon">serialize</a>
278 </li>
279 <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static tsd-is-external">
280 <a href="_types_src_typeparser_.typeparser.html#typed" class="tsd-kind-icon">typed</a>
281 </li>
282 </ul>
283 </li>
284 </ul>
285 <ul class="after-current">
286 </ul>
287 </nav>
288 </div>
289 </div>
290</div>
291<footer class="with-border-bottom">
292 <div class="container">
293 <h2>Legend</h2>
294 <div class="tsd-legend-group">
295 <ul class="tsd-legend">
296 <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
297 <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
298 <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
299 <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
300 <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
301 <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
302 <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
303 </ul>
304 <ul class="tsd-legend">
305 <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
306 <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
307 <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
308 <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
309 </ul>
310 <ul class="tsd-legend">
311 <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
312 <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
313 <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
314 <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
315 <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
316 <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
317 </ul>
318 <ul class="tsd-legend">
319 <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
320 <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
321 <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
322 <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
323 <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
324 <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
325 <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
326 </ul>
327 <ul class="tsd-legend">
328 <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
329 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
330 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
331 <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
332 </ul>
333 <ul class="tsd-legend">
334 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
335 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
336 <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
337 </ul>
338 <ul class="tsd-legend">
339 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
340 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
341 <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
342 </ul>
343 <ul class="tsd-legend">
344 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
345 <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
346 </ul>
347 </div>
348 </div>
349</footer>
350<div class="container tsd-generator">
351 <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
352</div>
353<div class="overlay"></div>
354<script src="../assets/js/main.js"></script>
355<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
356</body>
357</html>
\No newline at end of file