-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
419 lines (419 loc) · 22.5 KB
/
index.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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>generaptr</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">generaptr</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1> generaptr</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<h1 id="-http-i-imgur-com-ycrauba-png-"><img src="http://i.imgur.com/yCRAubA.png" alt=""></h1>
<p><a href="http://badge.fury.io/js/generaptr"><img src="https://badge.fury.io/js/generaptr.svg" alt="npm"></a> <a href="http://travis-ci.org/generaptr/generaptr"><img src="https://travis-ci.org/generaptr/generaptr.svg" alt="Build Status"></a> <a href="https://gitter.im/generaptr/generaptr?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img src="https://badges.gitter.im/generaptr/generaptr.svg" alt="Join the chat at https://gitter.im/generaptr/generaptr"></a> <a href="https://coveralls.io/github/generaptr/generaptr?branch=master"><img src="https://coveralls.io/repos/github/generaptr/generaptr/badge.svg?branch=master" alt="Coverage Status"></a> <a href="https://david-dm.org/cupsadarius/generaptr"><img src="https://david-dm.org/cupsadarius/generaptr.svg?theme=shields.io" alt="dependencies"></a> <a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/generaptr/generaptr.svg" alt="Greenkeeper badge"></a></p>
<p>Generaptr is a node cli package that helps when starting up a project by generating boilerplate code for Express api.</p>
<hr>
<h2 id="table-of-contents">Table of Contents</h2>
<ol>
<li><a href="#documentation">Documentation</a></li>
<li><a href="#minimum-requirements">Minimum Requirements</a></li>
<li><a href="#instalation">Installation</a></li>
<li><a href="#examples">Examples</a></li>
<li><a href="#support">Support</a></li>
<li><a href="#code-conduct">Code of Conduct</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#references">References</a></li>
</ol>
<h2 id="goal-and-philosophy">Goal and Philosophy</h2>
<p><strong><code>Generaptr</code></strong> strives to be an easy and useful command line tool for generating boilerplate api for a given database structure.</p>
<p><strong><code>Generaptr</code></strong> should ease the process of:</p>
<ul>
<li>starting a new backend project</li>
<li>writing boilerplate crud operations</li>
<li>writing api specs</li>
</ul>
<h2 id="-documentation-documentation-"><a href="#documentation">Documentation</a></h2>
<p><a name="documentation"></a></p>
<h3 id="-minimum-requirements-minimum-requirements-"><a href="#minimum-requirements">Minimum Requirements</a></h3>
<p><a name="minimum-requirements"></a>
The package was developed under <code>node 7.5</code> so a minimum requirement would be:</p>
<ul>
<li><code>node >= v7.5.0</code></li>
<li><code>npm >= v3.10.10</code><h3 id="-installation-instalation-"><a href="#instalation">Installation</a></h3>
<a name="instalation"></a></li>
</ul>
<pre><code class="lang-shell">npm install generaptr
</code></pre>
<h3 id="-examples-examples-"><a href="#examples">Examples</a></h3>
<p><a name="examples"></a></p>
<p>When starting generaptr the screen displayed below will appear.</p>
<p><img src="./assets/generaptr.png" alt=""></p>
<p>Here, the two possible actions are shown, actions which will decide on which flow will the execution continue:</p>
<ul>
<li><a href="#raml-flow">raml</a></li>
<li><a href="#api-flow">api</a><h4 id="-generate-raml-spec-flow-raml-flow-"><a href="#raml-flow">Generate Raml spec flow</a></h4>
<a name="raml-flow"></a></li>
</ul>
<p>Required information for generating the raml api spec is presented in the next screen.</p>
<p><img src="./assets/spec/raml-info.png" alt=""></p>
<p><img src="./assets/spec/raml-final.png" alt=""></p>
<p>In the screenshot we can see the logs from a successful api spec generation.</p>
<p><img src="./assets/spec/raml-folders.png" alt=""></p>
<p>Folder structure for a generated api spec.</p>
<h4 id="-generate-api-flow-api-flow-"><a href="#api-flow">Generate Api flow</a></h4>
<p><a name="api-flow"></a> </p>
<p>While generating the api boilerplate a few things are required, things which will be made clear in the next screenshots.</p>
<p><img src="./assets/api/api-input-choice.png" alt=""></p>
<p>In the screenshot above the user is prompted to choose the input source, right now we support a database connection or a valid raml spec (works best with raml spec's generated by generaptr).</p>
<p><img src="./assets/api/api-input-output-choice.png" alt=""></p>
<p>In the screenshot above presents the database output choice, currently we only support MySql but more will come in the future.</p>
<p><img src="./assets/api/api-input-mysql-info.png" alt=""></p>
<p><img src="./assets/api/api-input-mysql-final.png" alt=""></p>
<p>In the last two screenshots we can see the logs from a successful api generation.</p>
<p><img src="./assets/api/api-input-raml-final.png" alt=""></p>
<p>Following the same steps but with a different input source renders the same result.</p>
<p><img src="./assets/api/api-folders.png" alt=""></p>
<p>Folder structure for a generated api boilerplate.</p>
<h2 id="-support-support-"><a href="#support">Support</a></h2>
<p><a name="support"></a>
You should expect mostly good support for the CLI below. This does not mean we won't
look at issues found on other command line - feel free to report any!</p>
<ul>
<li><strong>Mac OS</strong>:<ul>
<li>Terminal.app</li>
<li>iTerm</li>
</ul>
</li>
<li><strong>Windows</strong>:<ul>
<li>cmd.exe</li>
<li>Powershell</li>
<li>Cygwin</li>
</ul>
</li>
<li><strong>Linux (Ubuntu, openSUSE, Arch Linux, etc)</strong>:<ul>
<li>gnome-terminal (Terminal GNOME)</li>
<li>konsole<h2 id="-code-of-conduct-code-conduct-"><a href="#code-conduct">Code of Conduct</a></h2>
<a name="code-conduct"></a></li>
</ul>
</li>
</ul>
<p>See <a href="./CODE_OF_CONDUCT.md">Code of Conduct</a> for more information.</p>
<h2 id="-contributing-contributing-"><a href="#contributing">Contributing</a></h2>
<p><a name="contributing"></a></p>
<p><strong>Unit test</strong></p>
<p>Unit test are written in <a href="https://mochajs.org/">Mocha</a> and <a href="https://nodejs.org/api/assert.html">Assert</a>. Please add a unit test for every new feature or bug fix. <code>npm test</code> to run the test suite.</p>
<p><strong>Documentation</strong></p>
<p>Add documentation for every API change. Feel free to send typo fixes and better docs!</p>
<h2 id="-license-license-"><a href="#license">License</a></h2>
<p><a name="license"></a></p>
<p>Copyright (c) 2017 Darius Cupsa (twitter: <a href="https://twitter.com/cupsadarius">@cupsadarius</a>)
Licensed under the MIT license.</p>
<h2 id="-references-references-"><a href="#references">References</a></h2>
<p><a name="references"></a></p>
<ul>
<li><a href="http://raml.org">RAML</a></li>
<li><a href="https://github.com/SBoudrias/Inquirer.js/">Inquirer.js</a></li>
<li><a href="https://expressjs.com">Express.js</a></li>
</ul>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_commons_constants_directorystructure_.html">"commons/constants/directory<wbr>Structure"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_commons_constants_propertiesname_.html">"commons/constants/properties<wbr>Name"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_commons_logger_.html">"commons/logger"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_commons_types_.html">"commons/types"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_commons_utils_cacheutil_.html">"commons/utils/cache<wbr>Util"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_commons_utils_fileutil_.html">"commons/utils/file<wbr>Util"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_commons_utils_ramlutil_.html">"commons/utils/raml<wbr>Util"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_commons_utils_schemautil_.html">"commons/utils/schema<wbr>Util"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_commons_utils_typeutil_.html">"commons/utils/type<wbr>Util"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_commons_utils_utils_.html">"commons/utils/utils"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_configs_config_.html">"configs/config"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_configs_logger_.html">"configs/logger"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fileoperations_apifileoperations_.html">"file<wbr>Operations/<wbr>Api<wbr>File<wbr>Operations"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fileoperations_ramlfileoperations_.html">"file<wbr>Operations/<wbr>Raml<wbr>File<wbr>Operations"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fileoperations_api_commonsfileoperations_.html">"file<wbr>Operations/api/commons<wbr>File<wbr>Operations"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fileoperations_api_configurationsfileoperations_.html">"file<wbr>Operations/api/configurations<wbr>File<wbr>Operations"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fileoperations_api_controllersfileoperations_.html">"file<wbr>Operations/api/controllers<wbr>File<wbr>Operations"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fileoperations_api_modelsfileoperations_.html">"file<wbr>Operations/api/models<wbr>File<wbr>Operations"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fileoperations_api_ormfileoperations_.html">"file<wbr>Operations/api/orm<wbr>File<wbr>Operations"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fileoperations_api_repositoriesfileoperations_.html">"file<wbr>Operations/api/repositories<wbr>File<wbr>Operations"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_fileoperations_api_servicesfileoperations_.html">"file<wbr>Operations/api/services<wbr>File<wbr>Operations"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generaptr_.html">"generaptr"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_commons_constants_.html">"generators/api/commons/constants"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_commons_util_.html">"generators/api/commons/util"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_config_config_.html">"generators/api/config/config"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_config_cors_.html">"generators/api/config/cors"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_config_express_.html">"generators/api/config/express"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_config_index_.html">"generators/api/config/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_config_router_.html">"generators/api/config/router"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_controllers_controller_.html">"generators/api/controllers/controller"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_models_index_.html">"generators/api/models/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_models_sequelize_.html">"generators/api/models/sequelize"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_packagejson_.html">"generators/api/package<wbr>Json"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_repositories_index_.html">"generators/api/repositories/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_repositories_sequelize_.html">"generators/api/repositories/sequelize"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_api_services_service_.html">"generators/api/services/service"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_spec_examples_.html">"generators/spec/examples"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_spec_spec_.html">"generators/spec/spec"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generators_spec_types_.html">"generators/spec/types"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_handlers_basehandler_.html">"handlers/<wbr>Base<wbr>Handler"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_handlers_mysqlhandler_.html">"handlers/<wbr>Mysql<wbr>Handler"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_handlers_ramlhandler_.html">"handlers/<wbr>Raml<wbr>Handler"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_preprocesors_mysqlschemapreprocessor_.html">"preprocesors/<wbr>Mysql<wbr>Schema<wbr>Preprocessor"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_preprocesors_ramlschemapreprocessor_.html">"preprocesors/<wbr>Raml<wbr>Schema<wbr>Preprocessor"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tracks_generaptr_.html">"tracks/generaptr"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tracks_inputs_database_databasetype_.html">"tracks/inputs/database/database<wbr>Type"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tracks_inputs_database_relational_mysql_.html">"tracks/inputs/database/relational/mysql"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tracks_inputs_database_relational_relational_.html">"tracks/inputs/database/relational/relational"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tracks_inputs_input_.html">"tracks/inputs/input"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tracks_inputs_raml_raml_.html">"tracks/inputs/raml/raml"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tracks_outputs_apioutput_.html">"tracks/outputs/api<wbr>Output"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tracks_outputs_database_dialect_.html">"tracks/outputs/database/dialect"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tracks_outputs_database_mysql_.html">"tracks/outputs/database/mysql"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tracks_outputs_ramloutput_.html">"tracks/outputs/raml<wbr>Output"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>