@jwn-js/common 1.3.21 → 1.3.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Jwt-e49753f6.js +57 -0
- package/Jwt.d.ts +5 -25
- package/Jwt.js +3 -43
- package/{Server-77093d28.js → Server-dadc1f87.js} +5 -5
- package/Server.js +1 -1
- package/docs/.nojekyll +1 -0
- package/docs/assets/highlight.css +36 -0
- package/docs/assets/icons.css +1043 -0
- package/docs/assets/{images/icons.png → icons.png} +0 -0
- package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
- package/docs/assets/main.js +52 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1388 -0
- package/docs/assets/{images/widgets.png → widgets.png} +0 -0
- package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
- package/docs/classes/ApiError.html +18 -560
- package/docs/classes/AsyncJwt.html +17 -0
- package/docs/classes/Controller.html +27 -1008
- package/docs/classes/Jwt.html +17 -374
- package/docs/classes/Memcached.html +20 -387
- package/docs/classes/Model.html +7 -667
- package/docs/classes/Server.html +25 -464
- package/docs/classes/Ssr.html +11 -310
- package/docs/classes/Web.html +11 -440
- package/docs/index.html +18 -258
- package/docs/interfaces/ApiErrorMessage.html +1 -222
- package/docs/interfaces/ContextSsr.html +23 -327
- package/docs/interfaces/ContextWeb.html +1 -291
- package/docs/interfaces/OptionsSsr.html +1 -184
- package/docs/interfaces/OptionsWeb.html +1 -212
- package/docs/interfaces/Route.html +1 -194
- package/docs/interfaces/Schema.html +1 -180
- package/docs/interfaces/ServerHandler.html +1 -221
- package/docs/interfaces/ServerOptions.html +1 -236
- package/docs/interfaces/ServerWebsocket.html +1 -194
- package/docs/modules.html +70 -2004
- package/index.d.ts +50 -1
- package/index.js +67 -14
- package/multipartBody.js +1 -1
- package/package.json +4 -4
- package/readConfig.js +1 -1
- package/readConfigSync.js +2 -2
- package/staticBody.js +1 -1
- package/urlencodedBody.js +1 -1
- package/docs/assets/css/main.css +0 -2660
- package/docs/assets/js/main.js +0 -248
- package/docs/assets/js/search.js +0 -1
package/docs/classes/Server.html
CHANGED
|
@@ -1,464 +1,25 @@
|
|
|
1
|
-
<!
|
|
2
|
-
<html class="
|
|
3
|
-
<
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
</
|
|
12
|
-
<
|
|
13
|
-
<
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
<a href="../index.html" class="title">@jwn-js/common - v1.3.21</a>
|
|
27
|
-
</div>
|
|
28
|
-
<div class="table-cell" id="tsd-widgets">
|
|
29
|
-
<div id="tsd-filter">
|
|
30
|
-
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
31
|
-
<div class="tsd-filter-group">
|
|
32
|
-
<div class="tsd-select" id="tsd-filter-visibility">
|
|
33
|
-
<span class="tsd-select-label">All</span>
|
|
34
|
-
<ul class="tsd-select-list">
|
|
35
|
-
<li data-value="public">Public</li>
|
|
36
|
-
<li data-value="protected">Public/Protected</li>
|
|
37
|
-
<li data-value="private" class="selected">All</li>
|
|
38
|
-
</ul>
|
|
39
|
-
</div>
|
|
40
|
-
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
41
|
-
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
42
|
-
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
43
|
-
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
44
|
-
</div>
|
|
45
|
-
</div>
|
|
46
|
-
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
47
|
-
</div>
|
|
48
|
-
</div>
|
|
49
|
-
</div>
|
|
50
|
-
</div>
|
|
51
|
-
<div class="tsd-page-title">
|
|
52
|
-
<div class="container">
|
|
53
|
-
<ul class="tsd-breadcrumb">
|
|
54
|
-
<li>
|
|
55
|
-
<a href="../modules.html">@jwn-js/common - v1.3.21</a>
|
|
56
|
-
</li>
|
|
57
|
-
<li>
|
|
58
|
-
<a href="Server.html">Server</a>
|
|
59
|
-
</li>
|
|
60
|
-
</ul>
|
|
61
|
-
<h1>Class Server</h1>
|
|
62
|
-
</div>
|
|
63
|
-
</div>
|
|
64
|
-
</header>
|
|
65
|
-
<div class="container container-main">
|
|
66
|
-
<div class="row">
|
|
67
|
-
<div class="col-8 col-content">
|
|
68
|
-
<section class="tsd-panel tsd-comment">
|
|
69
|
-
<div class="tsd-comment tsd-typography">
|
|
70
|
-
<dl class="tsd-comment-tags">
|
|
71
|
-
<dt>exports</dt>
|
|
72
|
-
<dd></dd>
|
|
73
|
-
</dl>
|
|
74
|
-
</div>
|
|
75
|
-
</section>
|
|
76
|
-
<section class="tsd-panel tsd-hierarchy">
|
|
77
|
-
<h3>Hierarchy</h3>
|
|
78
|
-
<ul class="tsd-hierarchy">
|
|
79
|
-
<li>
|
|
80
|
-
<span class="target">Server</span>
|
|
81
|
-
</li>
|
|
82
|
-
</ul>
|
|
83
|
-
</section>
|
|
84
|
-
<section class="tsd-panel-group tsd-index-group">
|
|
85
|
-
<h2>Index</h2>
|
|
86
|
-
<section class="tsd-panel tsd-index-panel">
|
|
87
|
-
<div class="tsd-index-content">
|
|
88
|
-
<section class="tsd-index-section ">
|
|
89
|
-
<h3>Constructors</h3>
|
|
90
|
-
<ul class="tsd-index-list">
|
|
91
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Server.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
92
|
-
</ul>
|
|
93
|
-
</section>
|
|
94
|
-
<section class="tsd-index-section ">
|
|
95
|
-
<h3>Methods</h3>
|
|
96
|
-
<ul class="tsd-index-list">
|
|
97
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#app" class="tsd-kind-icon">app</a></li>
|
|
98
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#close" class="tsd-kind-icon">close</a></li>
|
|
99
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#getApp" class="tsd-kind-icon">get<wbr>App</a></li>
|
|
100
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#listen" class="tsd-kind-icon">listen</a></li>
|
|
101
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#push" class="tsd-kind-icon">push</a></li>
|
|
102
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#socketPort" class="tsd-kind-icon">socket<wbr>Port</a></li>
|
|
103
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#sslApp" class="tsd-kind-icon">ssl<wbr>App</a></li>
|
|
104
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#unshift" class="tsd-kind-icon">unshift</a></li>
|
|
105
|
-
</ul>
|
|
106
|
-
</section>
|
|
107
|
-
</div>
|
|
108
|
-
</section>
|
|
109
|
-
</section>
|
|
110
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
111
|
-
<h2>Constructors</h2>
|
|
112
|
-
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
113
|
-
<a name="constructor" class="tsd-anchor"></a>
|
|
114
|
-
<h3>constructor</h3>
|
|
115
|
-
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
116
|
-
<li class="tsd-signature tsd-kind-icon">new <wbr>Server<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ServerOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li>
|
|
117
|
-
</ul>
|
|
118
|
-
<ul class="tsd-descriptions">
|
|
119
|
-
<li class="tsd-description">
|
|
120
|
-
<aside class="tsd-sources">
|
|
121
|
-
<ul>
|
|
122
|
-
<li>Defined in src/Server/Server.ts:144</li>
|
|
123
|
-
</ul>
|
|
124
|
-
</aside>
|
|
125
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
126
|
-
<ul class="tsd-parameters">
|
|
127
|
-
<li>
|
|
128
|
-
<h5>options: <a href="../interfaces/ServerOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerOptions</a></h5>
|
|
129
|
-
<div class="tsd-comment tsd-typography">
|
|
130
|
-
<div class="lead">
|
|
131
|
-
</div>
|
|
132
|
-
</div>
|
|
133
|
-
</li>
|
|
134
|
-
</ul>
|
|
135
|
-
<h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4>
|
|
136
|
-
</li>
|
|
137
|
-
</ul>
|
|
138
|
-
</section>
|
|
139
|
-
</section>
|
|
140
|
-
<section class="tsd-panel-group tsd-member-group ">
|
|
141
|
-
<h2>Methods</h2>
|
|
142
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
143
|
-
<a name="app" class="tsd-anchor"></a>
|
|
144
|
-
<h3>app</h3>
|
|
145
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
146
|
-
<li class="tsd-signature tsd-kind-icon">app<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li>
|
|
147
|
-
</ul>
|
|
148
|
-
<ul class="tsd-descriptions">
|
|
149
|
-
<li class="tsd-description">
|
|
150
|
-
<aside class="tsd-sources">
|
|
151
|
-
<ul>
|
|
152
|
-
<li>Defined in src/Server/Server.ts:165</li>
|
|
153
|
-
</ul>
|
|
154
|
-
</aside>
|
|
155
|
-
<div class="tsd-comment tsd-typography">
|
|
156
|
-
<div class="lead">
|
|
157
|
-
<p>Create app (server http)</p>
|
|
158
|
-
</div>
|
|
159
|
-
</div>
|
|
160
|
-
<h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4>
|
|
161
|
-
<p>this</p>
|
|
162
|
-
</li>
|
|
163
|
-
</ul>
|
|
164
|
-
</section>
|
|
165
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
166
|
-
<a name="close" class="tsd-anchor"></a>
|
|
167
|
-
<h3>close</h3>
|
|
168
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
169
|
-
<li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a><span class="tsd-signature-symbol">></span></li>
|
|
170
|
-
</ul>
|
|
171
|
-
<ul class="tsd-descriptions">
|
|
172
|
-
<li class="tsd-description">
|
|
173
|
-
<aside class="tsd-sources">
|
|
174
|
-
<ul>
|
|
175
|
-
<li>Defined in src/Server/Server.ts:298</li>
|
|
176
|
-
</ul>
|
|
177
|
-
</aside>
|
|
178
|
-
<div class="tsd-comment tsd-typography">
|
|
179
|
-
<div class="lead">
|
|
180
|
-
<p>Closes a uSockets listen socket.</p>
|
|
181
|
-
</div>
|
|
182
|
-
</div>
|
|
183
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a><span class="tsd-signature-symbol">></span></h4>
|
|
184
|
-
</li>
|
|
185
|
-
</ul>
|
|
186
|
-
</section>
|
|
187
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
188
|
-
<a name="getApp" class="tsd-anchor"></a>
|
|
189
|
-
<h3>get<wbr>App</h3>
|
|
190
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
191
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>App<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TemplatedApp</span></li>
|
|
192
|
-
</ul>
|
|
193
|
-
<ul class="tsd-descriptions">
|
|
194
|
-
<li class="tsd-description">
|
|
195
|
-
<aside class="tsd-sources">
|
|
196
|
-
<ul>
|
|
197
|
-
<li>Defined in src/Server/Server.ts:156</li>
|
|
198
|
-
</ul>
|
|
199
|
-
</aside>
|
|
200
|
-
<div class="tsd-comment tsd-typography">
|
|
201
|
-
<div class="lead">
|
|
202
|
-
<p>Get TemplatedApp instance</p>
|
|
203
|
-
</div>
|
|
204
|
-
</div>
|
|
205
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TemplatedApp</span></h4>
|
|
206
|
-
</li>
|
|
207
|
-
</ul>
|
|
208
|
-
</section>
|
|
209
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
210
|
-
<a name="listen" class="tsd-anchor"></a>
|
|
211
|
-
<h3>listen</h3>
|
|
212
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
213
|
-
<li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, fn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li>
|
|
214
|
-
<li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, fn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li>
|
|
215
|
-
<li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li>
|
|
216
|
-
</ul>
|
|
217
|
-
<ul class="tsd-descriptions">
|
|
218
|
-
<li class="tsd-description">
|
|
219
|
-
<aside class="tsd-sources">
|
|
220
|
-
<ul>
|
|
221
|
-
<li>Defined in src/Server/Server.ts:212</li>
|
|
222
|
-
</ul>
|
|
223
|
-
</aside>
|
|
224
|
-
<div class="tsd-comment tsd-typography">
|
|
225
|
-
<div class="lead">
|
|
226
|
-
<p>Create server listener</p>
|
|
227
|
-
</div>
|
|
228
|
-
</div>
|
|
229
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
230
|
-
<ul class="tsd-parameters">
|
|
231
|
-
<li>
|
|
232
|
-
<h5>host: <span class="tsd-signature-type">string</span></h5>
|
|
233
|
-
<div class="tsd-comment tsd-typography">
|
|
234
|
-
<p>host or port</p>
|
|
235
|
-
</div>
|
|
236
|
-
</li>
|
|
237
|
-
<li>
|
|
238
|
-
<h5>port: <span class="tsd-signature-type">number</span></h5>
|
|
239
|
-
</li>
|
|
240
|
-
<li>
|
|
241
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> fn: <span class="tsd-signature-type">CallableFunction</span></h5>
|
|
242
|
-
</li>
|
|
243
|
-
</ul>
|
|
244
|
-
<h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4>
|
|
245
|
-
<p>this</p>
|
|
246
|
-
</li>
|
|
247
|
-
<li class="tsd-description">
|
|
248
|
-
<aside class="tsd-sources">
|
|
249
|
-
<ul>
|
|
250
|
-
<li>Defined in src/Server/Server.ts:213</li>
|
|
251
|
-
</ul>
|
|
252
|
-
</aside>
|
|
253
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
254
|
-
<ul class="tsd-parameters">
|
|
255
|
-
<li>
|
|
256
|
-
<h5>port: <span class="tsd-signature-type">number</span></h5>
|
|
257
|
-
</li>
|
|
258
|
-
<li>
|
|
259
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> fn: <span class="tsd-signature-type">CallableFunction</span></h5>
|
|
260
|
-
</li>
|
|
261
|
-
</ul>
|
|
262
|
-
<h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4>
|
|
263
|
-
</li>
|
|
264
|
-
<li class="tsd-description">
|
|
265
|
-
<aside class="tsd-sources">
|
|
266
|
-
<ul>
|
|
267
|
-
<li>Defined in src/Server/Server.ts:214</li>
|
|
268
|
-
</ul>
|
|
269
|
-
</aside>
|
|
270
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
271
|
-
<ul class="tsd-parameters">
|
|
272
|
-
<li>
|
|
273
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> fn: <span class="tsd-signature-type">CallableFunction</span></h5>
|
|
274
|
-
</li>
|
|
275
|
-
</ul>
|
|
276
|
-
<h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4>
|
|
277
|
-
</li>
|
|
278
|
-
</ul>
|
|
279
|
-
</section>
|
|
280
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
281
|
-
<a name="push" class="tsd-anchor"></a>
|
|
282
|
-
<h3>push</h3>
|
|
283
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
284
|
-
<li class="tsd-signature tsd-kind-icon">push<span class="tsd-signature-symbol">(</span>route<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerHandler.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerHandler</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerWebsocket.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerWebsocket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li>
|
|
285
|
-
</ul>
|
|
286
|
-
<ul class="tsd-descriptions">
|
|
287
|
-
<li class="tsd-description">
|
|
288
|
-
<aside class="tsd-sources">
|
|
289
|
-
<ul>
|
|
290
|
-
<li>Defined in src/Server/Server.ts:188</li>
|
|
291
|
-
</ul>
|
|
292
|
-
</aside>
|
|
293
|
-
<div class="tsd-comment tsd-typography">
|
|
294
|
-
<div class="lead">
|
|
295
|
-
<p>Push route</p>
|
|
296
|
-
</div>
|
|
297
|
-
</div>
|
|
298
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
299
|
-
<ul class="tsd-parameters">
|
|
300
|
-
<li>
|
|
301
|
-
<h5>route: <span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerHandler.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerHandler</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerWebsocket.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerWebsocket</a></h5>
|
|
302
|
-
</li>
|
|
303
|
-
</ul>
|
|
304
|
-
<h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4>
|
|
305
|
-
<p>this</p>
|
|
306
|
-
</li>
|
|
307
|
-
</ul>
|
|
308
|
-
</section>
|
|
309
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
310
|
-
<a name="socketPort" class="tsd-anchor"></a>
|
|
311
|
-
<h3>socket<wbr>Port</h3>
|
|
312
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
313
|
-
<li class="tsd-signature tsd-kind-icon">socket<wbr>Port<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li>
|
|
314
|
-
</ul>
|
|
315
|
-
<ul class="tsd-descriptions">
|
|
316
|
-
<li class="tsd-description">
|
|
317
|
-
<aside class="tsd-sources">
|
|
318
|
-
<ul>
|
|
319
|
-
<li>Defined in src/Server/Server.ts:318</li>
|
|
320
|
-
</ul>
|
|
321
|
-
</aside>
|
|
322
|
-
<div class="tsd-comment tsd-typography">
|
|
323
|
-
<div class="lead">
|
|
324
|
-
<p>Return socket port</p>
|
|
325
|
-
</div>
|
|
326
|
-
</div>
|
|
327
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4>
|
|
328
|
-
</li>
|
|
329
|
-
</ul>
|
|
330
|
-
</section>
|
|
331
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
332
|
-
<a name="sslApp" class="tsd-anchor"></a>
|
|
333
|
-
<h3>ssl<wbr>App</h3>
|
|
334
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
335
|
-
<li class="tsd-signature tsd-kind-icon">ssl<wbr>App<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li>
|
|
336
|
-
</ul>
|
|
337
|
-
<ul class="tsd-descriptions">
|
|
338
|
-
<li class="tsd-description">
|
|
339
|
-
<aside class="tsd-sources">
|
|
340
|
-
<ul>
|
|
341
|
-
<li>Defined in src/Server/Server.ts:176</li>
|
|
342
|
-
</ul>
|
|
343
|
-
</aside>
|
|
344
|
-
<div class="tsd-comment tsd-typography">
|
|
345
|
-
<div class="lead">
|
|
346
|
-
<p>Create sslApp</p>
|
|
347
|
-
</div>
|
|
348
|
-
</div>
|
|
349
|
-
<h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4>
|
|
350
|
-
<p>this</p>
|
|
351
|
-
</li>
|
|
352
|
-
</ul>
|
|
353
|
-
</section>
|
|
354
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
355
|
-
<a name="unshift" class="tsd-anchor"></a>
|
|
356
|
-
<h3>unshift</h3>
|
|
357
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
358
|
-
<li class="tsd-signature tsd-kind-icon">unshift<span class="tsd-signature-symbol">(</span>route<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerHandler.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerHandler</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerWebsocket.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerWebsocket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li>
|
|
359
|
-
</ul>
|
|
360
|
-
<ul class="tsd-descriptions">
|
|
361
|
-
<li class="tsd-description">
|
|
362
|
-
<aside class="tsd-sources">
|
|
363
|
-
<ul>
|
|
364
|
-
<li>Defined in src/Server/Server.ts:199</li>
|
|
365
|
-
</ul>
|
|
366
|
-
</aside>
|
|
367
|
-
<div class="tsd-comment tsd-typography">
|
|
368
|
-
<div class="lead">
|
|
369
|
-
<p>unshift route</p>
|
|
370
|
-
</div>
|
|
371
|
-
</div>
|
|
372
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
373
|
-
<ul class="tsd-parameters">
|
|
374
|
-
<li>
|
|
375
|
-
<h5>route: <span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerHandler.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerHandler</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerWebsocket.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerWebsocket</a></h5>
|
|
376
|
-
</li>
|
|
377
|
-
</ul>
|
|
378
|
-
<h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4>
|
|
379
|
-
<p>this</p>
|
|
380
|
-
</li>
|
|
381
|
-
</ul>
|
|
382
|
-
</section>
|
|
383
|
-
</section>
|
|
384
|
-
</div>
|
|
385
|
-
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
386
|
-
<nav class="tsd-navigation primary">
|
|
387
|
-
<ul>
|
|
388
|
-
<li class=" ">
|
|
389
|
-
<a href="../modules.html">Exports</a>
|
|
390
|
-
</li>
|
|
391
|
-
</ul>
|
|
392
|
-
</nav>
|
|
393
|
-
<nav class="tsd-navigation secondary menu-sticky">
|
|
394
|
-
<ul class="before-current">
|
|
395
|
-
</ul>
|
|
396
|
-
<ul class="current">
|
|
397
|
-
<li class="current tsd-kind-class">
|
|
398
|
-
<a href="Server.html" class="tsd-kind-icon">Server</a>
|
|
399
|
-
<ul>
|
|
400
|
-
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
401
|
-
<a href="Server.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
402
|
-
</li>
|
|
403
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
404
|
-
<a href="Server.html#app" class="tsd-kind-icon">app</a>
|
|
405
|
-
</li>
|
|
406
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
407
|
-
<a href="Server.html#close" class="tsd-kind-icon">close</a>
|
|
408
|
-
</li>
|
|
409
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
410
|
-
<a href="Server.html#getApp" class="tsd-kind-icon">get<wbr>App</a>
|
|
411
|
-
</li>
|
|
412
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
413
|
-
<a href="Server.html#listen" class="tsd-kind-icon">listen</a>
|
|
414
|
-
</li>
|
|
415
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
416
|
-
<a href="Server.html#push" class="tsd-kind-icon">push</a>
|
|
417
|
-
</li>
|
|
418
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
419
|
-
<a href="Server.html#socketPort" class="tsd-kind-icon">socket<wbr>Port</a>
|
|
420
|
-
</li>
|
|
421
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
422
|
-
<a href="Server.html#sslApp" class="tsd-kind-icon">ssl<wbr>App</a>
|
|
423
|
-
</li>
|
|
424
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
425
|
-
<a href="Server.html#unshift" class="tsd-kind-icon">unshift</a>
|
|
426
|
-
</li>
|
|
427
|
-
</ul>
|
|
428
|
-
</li>
|
|
429
|
-
</ul>
|
|
430
|
-
<ul class="after-current">
|
|
431
|
-
</ul>
|
|
432
|
-
</nav>
|
|
433
|
-
</div>
|
|
434
|
-
</div>
|
|
435
|
-
</div>
|
|
436
|
-
<footer class="with-border-bottom">
|
|
437
|
-
<div class="container">
|
|
438
|
-
<h2>Legend</h2>
|
|
439
|
-
<div class="tsd-legend-group">
|
|
440
|
-
<ul class="tsd-legend">
|
|
441
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
442
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
443
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
444
|
-
</ul>
|
|
445
|
-
<ul class="tsd-legend">
|
|
446
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
447
|
-
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
448
|
-
</ul>
|
|
449
|
-
<ul class="tsd-legend">
|
|
450
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
|
451
|
-
</ul>
|
|
452
|
-
<ul class="tsd-legend">
|
|
453
|
-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
454
|
-
</ul>
|
|
455
|
-
</div>
|
|
456
|
-
</div>
|
|
457
|
-
</footer>
|
|
458
|
-
<div class="container tsd-generator">
|
|
459
|
-
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
460
|
-
</div>
|
|
461
|
-
<div class="overlay"></div>
|
|
462
|
-
<script src="../assets/js/main.js"></script>
|
|
463
|
-
</body>
|
|
464
|
-
</html>
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Server | @jwn-js/common - v1.3.25</title><meta name="description" content="Documentation for @jwn-js/common - v1.3.25"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@jwn-js/common - v1.3.25</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></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="../modules.html">@jwn-js/common - v1.3.25</a></li><li><a href="Server.html">Server</a></li></ul><h1>Class Server</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>exports</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Server</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Server.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#app" class="tsd-kind-icon">app</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#close" class="tsd-kind-icon">close</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#getApp" class="tsd-kind-icon">get<wbr/>App</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#listen" class="tsd-kind-icon">listen</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#push" class="tsd-kind-icon">push</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#socketPort" class="tsd-kind-icon">socket<wbr/>Port</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#sslApp" class="tsd-kind-icon">ssl<wbr/>App</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#unshift" class="tsd-kind-icon">unshift</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Server<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ServerOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Server/Server.ts:144</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/ServerOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
+
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="app" class="tsd-anchor"></a><h3>app</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">app<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Server/Server.ts:165</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
3
|
+
<p>Create app (server http)</p>
|
|
4
|
+
</div></div><h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4><div><p>this</p>
|
|
5
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="close" class="tsd-anchor"></a><h3>close</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Server/Server.ts:298</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
6
|
+
<p>Closes a uSockets listen socket.</p>
|
|
7
|
+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getApp" class="tsd-anchor"></a><h3>get<wbr/>App</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>App<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TemplatedApp</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Server/Server.ts:156</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
|
+
<p>Get TemplatedApp instance</p>
|
|
9
|
+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">TemplatedApp</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="listen" class="tsd-anchor"></a><h3>listen</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, fn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li><li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, fn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li><li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Server/Server.ts:212</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
10
|
+
<p>Create server listener</p>
|
|
11
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>host: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
|
+
<p>host or port</p>
|
|
13
|
+
</div></div></li><li><h5>port: <span class="tsd-signature-type">number</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> fn: <span class="tsd-signature-type">CallableFunction</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4><div><p>this</p>
|
|
14
|
+
</div></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Server/Server.ts:213</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>port: <span class="tsd-signature-type">number</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> fn: <span class="tsd-signature-type">CallableFunction</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Server/Server.ts:214</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> fn: <span class="tsd-signature-type">CallableFunction</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="push" class="tsd-anchor"></a><h3>push</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">push<span class="tsd-signature-symbol">(</span>route<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerHandler.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerHandler</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerWebsocket.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerWebsocket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Server/Server.ts:188</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
15
|
+
<p>Push route</p>
|
|
16
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>route: <span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerHandler.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerHandler</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerWebsocket.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerWebsocket</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4><div><p>this</p>
|
|
17
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="socketPort" class="tsd-anchor"></a><h3>socket<wbr/>Port</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">socket<wbr/>Port<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Server/Server.ts:318</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
18
|
+
<p>Return socket port</p>
|
|
19
|
+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="sslApp" class="tsd-anchor"></a><h3>ssl<wbr/>App</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">ssl<wbr/>App<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Server/Server.ts:176</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
20
|
+
<p>Create sslApp</p>
|
|
21
|
+
</div></div><h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4><div><p>this</p>
|
|
22
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="unshift" class="tsd-anchor"></a><h3>unshift</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">unshift<span class="tsd-signature-symbol">(</span>route<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerHandler.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerHandler</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerWebsocket.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerWebsocket</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Server/Server.ts:199</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
23
|
+
<p>unshift route</p>
|
|
24
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>route: <span class="tsd-signature-type">CallableFunction</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerHandler.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerHandler</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ServerWebsocket.html" class="tsd-signature-type" data-tsd-kind="Interface">ServerWebsocket</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Server.html" class="tsd-signature-type" data-tsd-kind="Class">Server</a></h4><div><p>this</p>
|
|
25
|
+
</div></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="Server.html" class="tsd-kind-icon">Server</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Server.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#app" class="tsd-kind-icon">app</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#close" class="tsd-kind-icon">close</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#getApp" class="tsd-kind-icon">get<wbr/>App</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#listen" class="tsd-kind-icon">listen</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#push" class="tsd-kind-icon">push</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#socketPort" class="tsd-kind-icon">socket<wbr/>Port</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#sslApp" class="tsd-kind-icon">ssl<wbr/>App</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Server.html#unshift" class="tsd-kind-icon">unshift</a></li></ul></li></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-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></ul><ul class="tsd-legend"><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></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></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|