@jwn-js/common 1.3.22 → 2.0.1

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.
Files changed (60) hide show
  1. package/Jwt-e49753f6.js +57 -0
  2. package/Jwt.js +3 -43
  3. package/{Server-77093d28.js → Server-dadc1f87.js} +5 -5
  4. package/Server.js +1 -1
  5. package/docs/.nojekyll +1 -0
  6. package/docs/assets/highlight.css +36 -0
  7. package/docs/assets/icons.css +1043 -0
  8. package/docs/assets/{images/icons.png → icons.png} +0 -0
  9. package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  10. package/docs/assets/main.js +52 -0
  11. package/docs/assets/search.js +1 -0
  12. package/docs/assets/style.css +1388 -0
  13. package/docs/assets/{images/widgets.png → widgets.png} +0 -0
  14. package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  15. package/docs/classes/ApiError.html +18 -560
  16. package/docs/classes/AsyncJwt.html +17 -0
  17. package/docs/classes/Controller.html +27 -1008
  18. package/docs/classes/Jwt.html +17 -374
  19. package/docs/classes/Memcached.html +20 -387
  20. package/docs/classes/Model.html +7 -667
  21. package/docs/classes/Server.html +25 -464
  22. package/docs/classes/Ssr.html +11 -310
  23. package/docs/classes/Web.html +11 -440
  24. package/docs/index.html +18 -258
  25. package/docs/interfaces/ApiErrorMessage.html +1 -222
  26. package/docs/interfaces/ContextSsr.html +23 -327
  27. package/docs/interfaces/ContextWeb.html +1 -291
  28. package/docs/interfaces/OptionsSsr.html +1 -184
  29. package/docs/interfaces/OptionsWeb.html +1 -212
  30. package/docs/interfaces/Route.html +1 -194
  31. package/docs/interfaces/Schema.html +1 -180
  32. package/docs/interfaces/ServerHandler.html +1 -221
  33. package/docs/interfaces/ServerOptions.html +1 -236
  34. package/docs/interfaces/ServerWebsocket.html +1 -194
  35. package/docs/modules.html +87 -2004
  36. package/index.js +80 -15
  37. package/multipartBody.js +14 -2
  38. package/package.json +14 -14
  39. package/readConfig.js +1 -1
  40. package/readConfigSync.js +2 -2
  41. package/{ApiError.d.ts → src/ApiError/ApiError.d.ts} +0 -0
  42. package/src/Jwt/Jwt.d.ts +39 -0
  43. package/{Memcached.d.ts → src/Memcached/Memcached.d.ts} +0 -0
  44. package/{Server.d.ts → src/Server/Server.d.ts} +0 -0
  45. package/{cookieParse.d.ts → src/helpers/cookieParse.d.ts} +0 -0
  46. package/{cookieString.d.ts → src/helpers/cookieString.d.ts} +0 -0
  47. package/{jsonBody.d.ts → src/helpers/jsonBody.d.ts} +0 -0
  48. package/src/helpers/multipartBody.d.ts +33 -0
  49. package/{readConfig.d.ts → src/helpers/readConfig.d.ts} +0 -0
  50. package/{readConfigSync.d.ts → src/helpers/readConfigSync.d.ts} +0 -0
  51. package/{staticBody.d.ts → src/helpers/staticBody.d.ts} +0 -0
  52. package/{urlencodedBody.d.ts → src/helpers/urlencodedBody.d.ts} +0 -0
  53. package/{index.d.ts → src/index.d.ts} +54 -5
  54. package/staticBody.js +1 -1
  55. package/urlencodedBody.js +1 -1
  56. package/Jwt.d.ts +0 -59
  57. package/docs/assets/css/main.css +0 -2660
  58. package/docs/assets/js/main.js +0 -248
  59. package/docs/assets/js/search.js +0 -1
  60. package/multipartBody.d.ts +0 -11
package/docs/classes/Jwt.html CHANGED
@@ -1,374 +1,17 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>Jwt | @jwn-js/common - v1.3.22</title>
7
- <meta name="description" content="Documentation for @jwn-js/common - v1.3.22">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- <script async src="../assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
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.22</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.22</a>
56
- </li>
57
- <li>
58
- <a href="Jwt.html">Jwt</a>
59
- </li>
60
- </ul>
61
- <h1>Class Jwt</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">Jwt</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="Jwt.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="Jwt.html#decode" class="tsd-kind-icon">decode</a></li>
98
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="Jwt.html#sign" class="tsd-kind-icon">sign</a></li>
99
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="Jwt.html#verify" class="tsd-kind-icon">verify</a></li>
100
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Jwt.html#fromBase64url" class="tsd-kind-icon">from<wbr>Base64url</a></li>
101
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Jwt.html#toBase64url" class="tsd-kind-icon">to<wbr>Base64url</a></li>
102
- </ul>
103
- </section>
104
- </div>
105
- </section>
106
- </section>
107
- <section class="tsd-panel-group tsd-member-group ">
108
- <h2>Constructors</h2>
109
- <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
110
- <a name="constructor" class="tsd-anchor"></a>
111
- <h3>constructor</h3>
112
- <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
113
- <li class="tsd-signature tsd-kind-icon">new <wbr>Jwt<span class="tsd-signature-symbol">(</span>secret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Jwt.html" class="tsd-signature-type" data-tsd-kind="Class">Jwt</a></li>
114
- </ul>
115
- <ul class="tsd-descriptions">
116
- <li class="tsd-description">
117
- <aside class="tsd-sources">
118
- <ul>
119
- <li>Defined in src/Jwt/Jwt.ts:17</li>
120
- </ul>
121
- </aside>
122
- <h4 class="tsd-parameters-title">Parameters</h4>
123
- <ul class="tsd-parameters">
124
- <li>
125
- <h5>secret: <span class="tsd-signature-type">string</span></h5>
126
- <div class="tsd-comment tsd-typography">
127
- <div class="lead">
128
- </div>
129
- </div>
130
- </li>
131
- </ul>
132
- <h4 class="tsd-returns-title">Returns <a href="Jwt.html" class="tsd-signature-type" data-tsd-kind="Class">Jwt</a></h4>
133
- </li>
134
- </ul>
135
- </section>
136
- </section>
137
- <section class="tsd-panel-group tsd-member-group ">
138
- <h2>Methods</h2>
139
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
140
- <a name="decode" class="tsd-anchor"></a>
141
- <h3>decode</h3>
142
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
143
- <li class="tsd-signature tsd-kind-icon">decode<span class="tsd-signature-symbol">(</span>jwt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>head<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></li>
144
- </ul>
145
- <ul class="tsd-descriptions">
146
- <li class="tsd-description">
147
- <aside class="tsd-sources">
148
- <ul>
149
- <li>Defined in src/Jwt/Jwt.ts:62</li>
150
- </ul>
151
- </aside>
152
- <div class="tsd-comment tsd-typography">
153
- <div class="lead">
154
- <p>Decode token</p>
155
- </div>
156
- </div>
157
- <h4 class="tsd-parameters-title">Parameters</h4>
158
- <ul class="tsd-parameters">
159
- <li>
160
- <h5>jwt: <span class="tsd-signature-type">string</span></h5>
161
- <div class="tsd-comment tsd-typography">
162
- <p>jwt token</p>
163
- </div>
164
- </li>
165
- </ul>
166
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>head<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h4>
167
- <ul class="tsd-parameters">
168
- <li class="tsd-parameter">
169
- <h5>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
170
- </li>
171
- <li class="tsd-parameter">
172
- <h5>head<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
173
- </li>
174
- </ul>
175
- </li>
176
- </ul>
177
- </section>
178
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
179
- <a name="sign" class="tsd-anchor"></a>
180
- <h3>sign</h3>
181
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
182
- <li class="tsd-signature tsd-kind-icon">sign<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
183
- </ul>
184
- <ul class="tsd-descriptions">
185
- <li class="tsd-description">
186
- <aside class="tsd-sources">
187
- <ul>
188
- <li>Defined in src/Jwt/Jwt.ts:46</li>
189
- </ul>
190
- </aside>
191
- <div class="tsd-comment tsd-typography">
192
- <div class="lead">
193
- <p>Get token</p>
194
- </div>
195
- </div>
196
- <h4 class="tsd-parameters-title">Parameters</h4>
197
- <ul class="tsd-parameters">
198
- <li>
199
- <h5>data: <span class="tsd-signature-type">any</span></h5>
200
- <div class="tsd-comment tsd-typography">
201
- <p>user data</p>
202
- </div>
203
- </li>
204
- </ul>
205
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
206
- <p>jwt</p>
207
- </li>
208
- </ul>
209
- </section>
210
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
211
- <a name="verify" class="tsd-anchor"></a>
212
- <h3>verify</h3>
213
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
214
- <li class="tsd-signature tsd-kind-icon">verify<span class="tsd-signature-symbol">(</span>jwt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
215
- </ul>
216
- <ul class="tsd-descriptions">
217
- <li class="tsd-description">
218
- <aside class="tsd-sources">
219
- <ul>
220
- <li>Defined in src/Jwt/Jwt.ts:26</li>
221
- </ul>
222
- </aside>
223
- <div class="tsd-comment tsd-typography">
224
- <div class="lead">
225
- <p>Verify jwt token</p>
226
- </div>
227
- </div>
228
- <h4 class="tsd-parameters-title">Parameters</h4>
229
- <ul class="tsd-parameters">
230
- <li>
231
- <h5>jwt: <span class="tsd-signature-type">string</span></h5>
232
- <div class="tsd-comment tsd-typography">
233
- <p>token</p>
234
- </div>
235
- </li>
236
- </ul>
237
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
238
- <p>is token valid</p>
239
- </li>
240
- </ul>
241
- </section>
242
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
243
- <a name="fromBase64url" class="tsd-anchor"></a>
244
- <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Base64url</h3>
245
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
246
- <li class="tsd-signature tsd-kind-icon">from<wbr>Base64url<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
247
- </ul>
248
- <ul class="tsd-descriptions">
249
- <li class="tsd-description">
250
- <aside class="tsd-sources">
251
- <ul>
252
- <li>Defined in src/Jwt/Jwt.ts:87</li>
253
- </ul>
254
- </aside>
255
- <div class="tsd-comment tsd-typography">
256
- <div class="lead">
257
- <p>Parse json from jwt string</p>
258
- </div>
259
- </div>
260
- <h4 class="tsd-parameters-title">Parameters</h4>
261
- <ul class="tsd-parameters">
262
- <li>
263
- <h5>str: <span class="tsd-signature-type">string</span></h5>
264
- <div class="tsd-comment tsd-typography">
265
- <p>returns parse data</p>
266
- </div>
267
- </li>
268
- </ul>
269
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
270
- </li>
271
- </ul>
272
- </section>
273
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
274
- <a name="toBase64url" class="tsd-anchor"></a>
275
- <h3><span class="tsd-flag ts-flagStatic">Static</span> to<wbr>Base64url</h3>
276
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
277
- <li class="tsd-signature tsd-kind-icon">to<wbr>Base64url<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
278
- </ul>
279
- <ul class="tsd-descriptions">
280
- <li class="tsd-description">
281
- <aside class="tsd-sources">
282
- <ul>
283
- <li>Defined in src/Jwt/Jwt.ts:75</li>
284
- </ul>
285
- </aside>
286
- <div class="tsd-comment tsd-typography">
287
- <div class="lead">
288
- <p>To JSON stringify to base64 replace == at the end</p>
289
- </div>
290
- </div>
291
- <h4 class="tsd-parameters-title">Parameters</h4>
292
- <ul class="tsd-parameters">
293
- <li>
294
- <h5>params: <span class="tsd-signature-type">any</span></h5>
295
- </li>
296
- </ul>
297
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
298
- <p>base64url string</p>
299
- </li>
300
- </ul>
301
- </section>
302
- </section>
303
- </div>
304
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
305
- <nav class="tsd-navigation primary">
306
- <ul>
307
- <li class=" ">
308
- <a href="../modules.html">Exports</a>
309
- </li>
310
- </ul>
311
- </nav>
312
- <nav class="tsd-navigation secondary menu-sticky">
313
- <ul class="before-current">
314
- </ul>
315
- <ul class="current">
316
- <li class="current tsd-kind-class">
317
- <a href="Jwt.html" class="tsd-kind-icon">Jwt</a>
318
- <ul>
319
- <li class=" tsd-kind-constructor tsd-parent-kind-class">
320
- <a href="Jwt.html#constructor" class="tsd-kind-icon">constructor</a>
321
- </li>
322
- <li class=" tsd-kind-method tsd-parent-kind-class">
323
- <a href="Jwt.html#decode" class="tsd-kind-icon">decode</a>
324
- </li>
325
- <li class=" tsd-kind-method tsd-parent-kind-class">
326
- <a href="Jwt.html#sign" class="tsd-kind-icon">sign</a>
327
- </li>
328
- <li class=" tsd-kind-method tsd-parent-kind-class">
329
- <a href="Jwt.html#verify" class="tsd-kind-icon">verify</a>
330
- </li>
331
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
332
- <a href="Jwt.html#fromBase64url" class="tsd-kind-icon">from<wbr>Base64url</a>
333
- </li>
334
- <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
335
- <a href="Jwt.html#toBase64url" class="tsd-kind-icon">to<wbr>Base64url</a>
336
- </li>
337
- </ul>
338
- </li>
339
- </ul>
340
- <ul class="after-current">
341
- </ul>
342
- </nav>
343
- </div>
344
- </div>
345
- </div>
346
- <footer class="with-border-bottom">
347
- <div class="container">
348
- <h2>Legend</h2>
349
- <div class="tsd-legend-group">
350
- <ul class="tsd-legend">
351
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
352
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
353
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
354
- </ul>
355
- <ul class="tsd-legend">
356
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
357
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
358
- </ul>
359
- <ul class="tsd-legend">
360
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
361
- </ul>
362
- <ul class="tsd-legend">
363
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
364
- </ul>
365
- </div>
366
- </div>
367
- </footer>
368
- <div class="container tsd-generator">
369
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
370
- </div>
371
- <div class="overlay"></div>
372
- <script src="../assets/js/main.js"></script>
373
- </body>
374
- </html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Jwt | @jwn-js/common - v2.0.1</title><meta name="description" content="Documentation for @jwn-js/common - v2.0.1"/><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 - v2.0.1</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 - v2.0.1</a></li><li><a href="Jwt.html">Jwt</a></li></ul><h1>Class Jwt</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">Jwt</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="Jwt.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="Jwt.html#decode" class="tsd-kind-icon">decode</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Jwt.html#sign" class="tsd-kind-icon">sign</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Jwt.html#verify" class="tsd-kind-icon">verify</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/>Jwt<span class="tsd-signature-symbol">(</span>secret<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opt<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Jwt.html" class="tsd-signature-type" data-tsd-kind="Class">Jwt</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Jwt/Jwt.ts:21</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>secret: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> opt: <span class="tsd-signature-symbol">{ </span>algorithm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>addition options</p>
3
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>algorithm<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="Jwt.html" class="tsd-signature-type" data-tsd-kind="Class">Jwt</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="decode" class="tsd-anchor"></a><h3>decode</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">decode<span class="tsd-signature-symbol">(</span>jwt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>head<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/Jwt/Jwt.ts:74</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>Decode token</p>
5
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jwt: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>jwt token</p>
7
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>head<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h4><div></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5></li><li class="tsd-parameter"><h5>head<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="sign" class="tsd-anchor"></a><h3>sign</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">sign<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Jwt/Jwt.ts:55</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>Get token</p>
9
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>data: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>user data</p>
11
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div><p>jwt</p>
12
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="verify" class="tsd-anchor"></a><h3>verify</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">verify<span class="tsd-signature-symbol">(</span>jwt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/Jwt/Jwt.ts:35</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
13
+ <p>Verify jwt token</p>
14
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>jwt: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
15
+ <p>token</p>
16
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>is token valid</p>
17
+ </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="Jwt.html" class="tsd-kind-icon">Jwt</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Jwt.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Jwt.html#decode" class="tsd-kind-icon">decode</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Jwt.html#sign" class="tsd-kind-icon">sign</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Jwt.html#verify" class="tsd-kind-icon">verify</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>