@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
|
@@ -1,327 +1,23 @@
|
|
|
1
|
-
<!
|
|
2
|
-
<
|
|
3
|
-
<
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
</
|
|
12
|
-
<
|
|
13
|
-
<
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
<li class="state failure">The search index is not available</li>
|
|
25
|
-
</ul>
|
|
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="ContextSsr.html">ContextSsr</a>
|
|
59
|
-
</li>
|
|
60
|
-
</ul>
|
|
61
|
-
<h1>Interface ContextSsr</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>types</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">ContextSsr</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 tsd-is-external">
|
|
89
|
-
<h3>Properties</h3>
|
|
90
|
-
<ul class="tsd-index-list">
|
|
91
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#cookies" class="tsd-kind-icon">cookies</a></li>
|
|
92
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#headers" class="tsd-kind-icon">headers</a></li>
|
|
93
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#hostname" class="tsd-kind-icon">hostname</a></li>
|
|
94
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#ip" class="tsd-kind-icon">ip</a></li>
|
|
95
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#memcache" class="tsd-kind-icon">memcache</a></li>
|
|
96
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#protocol" class="tsd-kind-icon">protocol</a></li>
|
|
97
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a></li>
|
|
98
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#statusCode" class="tsd-kind-icon">status<wbr>Code</a></li>
|
|
99
|
-
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#url" class="tsd-kind-icon">url</a></li>
|
|
100
|
-
</ul>
|
|
101
|
-
</section>
|
|
102
|
-
</div>
|
|
103
|
-
</section>
|
|
104
|
-
</section>
|
|
105
|
-
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
106
|
-
<h2>Properties</h2>
|
|
107
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
108
|
-
<a name="cookies" class="tsd-anchor"></a>
|
|
109
|
-
<h3>cookies</h3>
|
|
110
|
-
<div class="tsd-signature tsd-kind-icon">cookies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
|
|
111
|
-
<aside class="tsd-sources">
|
|
112
|
-
<ul>
|
|
113
|
-
<li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:142</li>
|
|
114
|
-
</ul>
|
|
115
|
-
</aside>
|
|
116
|
-
<div class="tsd-comment tsd-typography">
|
|
117
|
-
<div class="lead">
|
|
118
|
-
<p>this property is an object that contains cookies sent by the request</p>
|
|
119
|
-
</div>
|
|
120
|
-
</div>
|
|
121
|
-
</section>
|
|
122
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
123
|
-
<a name="headers" class="tsd-anchor"></a>
|
|
124
|
-
<h3>headers</h3>
|
|
125
|
-
<div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
|
|
126
|
-
<aside class="tsd-sources">
|
|
127
|
-
<ul>
|
|
128
|
-
<li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:163</li>
|
|
129
|
-
</ul>
|
|
130
|
-
</aside>
|
|
131
|
-
<div class="tsd-comment tsd-typography">
|
|
132
|
-
<div class="lead">
|
|
133
|
-
<p>Request headers</p>
|
|
134
|
-
</div>
|
|
135
|
-
</div>
|
|
136
|
-
</section>
|
|
137
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
138
|
-
<a name="hostname" class="tsd-anchor"></a>
|
|
139
|
-
<h3>hostname</h3>
|
|
140
|
-
<div class="tsd-signature tsd-kind-icon">hostname<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
141
|
-
<aside class="tsd-sources">
|
|
142
|
-
<ul>
|
|
143
|
-
<li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:125</li>
|
|
144
|
-
</ul>
|
|
145
|
-
</aside>
|
|
146
|
-
<div class="tsd-comment tsd-typography">
|
|
147
|
-
<div class="lead">
|
|
148
|
-
<p>hostname (example.com)
|
|
149
|
-
as express req.hostname</p>
|
|
150
|
-
</div>
|
|
151
|
-
</div>
|
|
152
|
-
</section>
|
|
153
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
154
|
-
<a name="ip" class="tsd-anchor"></a>
|
|
155
|
-
<h3>ip</h3>
|
|
156
|
-
<div class="tsd-signature tsd-kind-icon">ip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
157
|
-
<aside class="tsd-sources">
|
|
158
|
-
<ul>
|
|
159
|
-
<li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:147</li>
|
|
160
|
-
</ul>
|
|
161
|
-
</aside>
|
|
162
|
-
<div class="tsd-comment tsd-typography">
|
|
163
|
-
<div class="lead">
|
|
164
|
-
<p>remote address (127.0.0.1)</p>
|
|
165
|
-
</div>
|
|
166
|
-
</div>
|
|
167
|
-
</section>
|
|
168
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
169
|
-
<a name="memcache" class="tsd-anchor"></a>
|
|
170
|
-
<h3>memcache</h3>
|
|
171
|
-
<div class="tsd-signature tsd-kind-icon">memcache<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
|
|
172
|
-
<aside class="tsd-sources">
|
|
173
|
-
<ul>
|
|
174
|
-
<li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:152</li>
|
|
175
|
-
</ul>
|
|
176
|
-
</aside>
|
|
177
|
-
<div class="tsd-comment tsd-typography">
|
|
178
|
-
<div class="lead">
|
|
179
|
-
<p>special property for usin memcached</p>
|
|
180
|
-
</div>
|
|
181
|
-
</div>
|
|
182
|
-
</section>
|
|
183
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
184
|
-
<a name="protocol" class="tsd-anchor"></a>
|
|
185
|
-
<h3>protocol</h3>
|
|
186
|
-
<div class="tsd-signature tsd-kind-icon">protocol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
187
|
-
<aside class="tsd-sources">
|
|
188
|
-
<ul>
|
|
189
|
-
<li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:131</li>
|
|
190
|
-
</ul>
|
|
191
|
-
</aside>
|
|
192
|
-
<div class="tsd-comment tsd-typography">
|
|
193
|
-
<div class="lead">
|
|
194
|
-
<p>protocol (http)
|
|
195
|
-
as express req.protocol</p>
|
|
196
|
-
</div>
|
|
197
|
-
</div>
|
|
198
|
-
</section>
|
|
199
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
200
|
-
<a name="responseHeaders" class="tsd-anchor"></a>
|
|
201
|
-
<h3>response<wbr>Headers</h3>
|
|
202
|
-
<div class="tsd-signature tsd-kind-icon">response<wbr>Headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
|
|
203
|
-
<aside class="tsd-sources">
|
|
204
|
-
<ul>
|
|
205
|
-
<li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:168</li>
|
|
206
|
-
</ul>
|
|
207
|
-
</aside>
|
|
208
|
-
<div class="tsd-comment tsd-typography">
|
|
209
|
-
<div class="lead">
|
|
210
|
-
<p>Response headers</p>
|
|
211
|
-
</div>
|
|
212
|
-
</div>
|
|
213
|
-
</section>
|
|
214
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
215
|
-
<a name="statusCode" class="tsd-anchor"></a>
|
|
216
|
-
<h3>status<wbr>Code</h3>
|
|
217
|
-
<div class="tsd-signature tsd-kind-icon">status<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
218
|
-
<aside class="tsd-sources">
|
|
219
|
-
<ul>
|
|
220
|
-
<li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:158</li>
|
|
221
|
-
</ul>
|
|
222
|
-
</aside>
|
|
223
|
-
<div class="tsd-comment tsd-typography">
|
|
224
|
-
<div class="lead">
|
|
225
|
-
<p>response status code
|
|
226
|
-
default 200</p>
|
|
227
|
-
</div>
|
|
228
|
-
</div>
|
|
229
|
-
</section>
|
|
230
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
231
|
-
<a name="url" class="tsd-anchor"></a>
|
|
232
|
-
<h3>url</h3>
|
|
233
|
-
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
234
|
-
<aside class="tsd-sources">
|
|
235
|
-
<ul>
|
|
236
|
-
<li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:137</li>
|
|
237
|
-
</ul>
|
|
238
|
-
</aside>
|
|
239
|
-
<div class="tsd-comment tsd-typography">
|
|
240
|
-
<div class="lead">
|
|
241
|
-
<p>string current url
|
|
242
|
-
/search?q=something</p>
|
|
243
|
-
</div>
|
|
244
|
-
</div>
|
|
245
|
-
</section>
|
|
246
|
-
</section>
|
|
247
|
-
</div>
|
|
248
|
-
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
249
|
-
<nav class="tsd-navigation primary">
|
|
250
|
-
<ul>
|
|
251
|
-
<li class=" ">
|
|
252
|
-
<a href="../modules.html">Exports</a>
|
|
253
|
-
</li>
|
|
254
|
-
</ul>
|
|
255
|
-
</nav>
|
|
256
|
-
<nav class="tsd-navigation secondary menu-sticky">
|
|
257
|
-
<ul class="before-current">
|
|
258
|
-
</ul>
|
|
259
|
-
<ul class="current">
|
|
260
|
-
<li class="current tsd-kind-interface tsd-is-external">
|
|
261
|
-
<a href="ContextSsr.html" class="tsd-kind-icon">Context<wbr>Ssr</a>
|
|
262
|
-
<ul>
|
|
263
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
264
|
-
<a href="ContextSsr.html#cookies" class="tsd-kind-icon">cookies</a>
|
|
265
|
-
</li>
|
|
266
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
267
|
-
<a href="ContextSsr.html#headers" class="tsd-kind-icon">headers</a>
|
|
268
|
-
</li>
|
|
269
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
270
|
-
<a href="ContextSsr.html#hostname" class="tsd-kind-icon">hostname</a>
|
|
271
|
-
</li>
|
|
272
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
273
|
-
<a href="ContextSsr.html#ip" class="tsd-kind-icon">ip</a>
|
|
274
|
-
</li>
|
|
275
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
276
|
-
<a href="ContextSsr.html#memcache" class="tsd-kind-icon">memcache</a>
|
|
277
|
-
</li>
|
|
278
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
279
|
-
<a href="ContextSsr.html#protocol" class="tsd-kind-icon">protocol</a>
|
|
280
|
-
</li>
|
|
281
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
282
|
-
<a href="ContextSsr.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a>
|
|
283
|
-
</li>
|
|
284
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
285
|
-
<a href="ContextSsr.html#statusCode" class="tsd-kind-icon">status<wbr>Code</a>
|
|
286
|
-
</li>
|
|
287
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
288
|
-
<a href="ContextSsr.html#url" class="tsd-kind-icon">url</a>
|
|
289
|
-
</li>
|
|
290
|
-
</ul>
|
|
291
|
-
</li>
|
|
292
|
-
</ul>
|
|
293
|
-
<ul class="after-current">
|
|
294
|
-
</ul>
|
|
295
|
-
</nav>
|
|
296
|
-
</div>
|
|
297
|
-
</div>
|
|
298
|
-
</div>
|
|
299
|
-
<footer class="with-border-bottom">
|
|
300
|
-
<div class="container">
|
|
301
|
-
<h2>Legend</h2>
|
|
302
|
-
<div class="tsd-legend-group">
|
|
303
|
-
<ul class="tsd-legend">
|
|
304
|
-
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
305
|
-
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
306
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
307
|
-
</ul>
|
|
308
|
-
<ul class="tsd-legend">
|
|
309
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
310
|
-
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
311
|
-
</ul>
|
|
312
|
-
<ul class="tsd-legend">
|
|
313
|
-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
|
314
|
-
</ul>
|
|
315
|
-
<ul class="tsd-legend">
|
|
316
|
-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
317
|
-
</ul>
|
|
318
|
-
</div>
|
|
319
|
-
</div>
|
|
320
|
-
</footer>
|
|
321
|
-
<div class="container tsd-generator">
|
|
322
|
-
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
323
|
-
</div>
|
|
324
|
-
<div class="overlay"></div>
|
|
325
|
-
<script src="../assets/js/main.js"></script>
|
|
326
|
-
</body>
|
|
327
|
-
</html>
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ContextSsr | @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="ContextSsr.html">ContextSsr</a></li></ul><h1>Interface ContextSsr</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>types</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ContextSsr</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 tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#cookies" class="tsd-kind-icon">cookies</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#headers" class="tsd-kind-icon">headers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#hostname" class="tsd-kind-icon">hostname</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#ip" class="tsd-kind-icon">ip</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#memcache" class="tsd-kind-icon">memcache</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#protocol" class="tsd-kind-icon">protocol</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#responseHeaders" class="tsd-kind-icon">response<wbr/>Headers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#statusCode" class="tsd-kind-icon">status<wbr/>Code</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#url" class="tsd-kind-icon">url</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="cookies" class="tsd-anchor"></a><h3>cookies</h3><div class="tsd-signature tsd-kind-icon">cookies<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:142</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
+
<p>this property is an object that contains cookies sent by the request</p>
|
|
3
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="headers" class="tsd-anchor"></a><h3>headers</h3><div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:163</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
|
+
<p>Request headers</p>
|
|
5
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="hostname" class="tsd-anchor"></a><h3>hostname</h3><div class="tsd-signature tsd-kind-icon">hostname<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:125</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
6
|
+
<p>hostname (example.com)
|
|
7
|
+
as express req.hostname</p>
|
|
8
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="ip" class="tsd-anchor"></a><h3>ip</h3><div class="tsd-signature tsd-kind-icon">ip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:147</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
9
|
+
<p>remote address (127.0.0.1)</p>
|
|
10
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="memcache" class="tsd-anchor"></a><h3>memcache</h3><div class="tsd-signature tsd-kind-icon">memcache<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:152</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
11
|
+
<p>special property for usin memcached</p>
|
|
12
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="protocol" class="tsd-anchor"></a><h3>protocol</h3><div class="tsd-signature tsd-kind-icon">protocol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:131</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
13
|
+
<p>protocol (http)
|
|
14
|
+
as express req.protocol</p>
|
|
15
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="responseHeaders" class="tsd-anchor"></a><h3>response<wbr/>Headers</h3><div class="tsd-signature tsd-kind-icon">response<wbr/>Headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:168</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
16
|
+
<p>Response headers</p>
|
|
17
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="statusCode" class="tsd-anchor"></a><h3>status<wbr/>Code</h3><div class="tsd-signature tsd-kind-icon">status<wbr/>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:158</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
18
|
+
<p>response status code
|
|
19
|
+
default 200</p>
|
|
20
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a id="url" class="tsd-anchor"></a><h3>url</h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/vite-ssr-vue/components-95cba9dd.d.ts:137</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
21
|
+
<p>string current url
|
|
22
|
+
/search?q=something</p>
|
|
23
|
+
</div></div></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-interface tsd-is-external"><a href="ContextSsr.html" class="tsd-kind-icon">Context<wbr/>Ssr</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#cookies" class="tsd-kind-icon">cookies</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#headers" class="tsd-kind-icon">headers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#hostname" class="tsd-kind-icon">hostname</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#ip" class="tsd-kind-icon">ip</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#memcache" class="tsd-kind-icon">memcache</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#protocol" class="tsd-kind-icon">protocol</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#responseHeaders" class="tsd-kind-icon">response<wbr/>Headers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#statusCode" class="tsd-kind-icon">status<wbr/>Code</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ContextSsr.html#url" class="tsd-kind-icon">url</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>
|