@rapidrest/service-core 1.0.0-beta.1 → 1.0.0-beta.2

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 (157) hide show
  1. package/dist/lib/auth/AuthMiddleware.js +33 -3
  2. package/dist/lib/auth/AuthMiddleware.js.map +1 -1
  3. package/dist/lib/auth/BasicStrategy.js +46 -39
  4. package/dist/lib/auth/BasicStrategy.js.map +1 -1
  5. package/dist/lib/auth/JWTStrategy.js +69 -60
  6. package/dist/lib/auth/JWTStrategy.js.map +1 -1
  7. package/dist/lib/index.js +2 -1
  8. package/dist/lib/index.js.map +1 -1
  9. package/dist/lib/routes/RouteUtils.js +8 -7
  10. package/dist/lib/routes/RouteUtils.js.map +1 -1
  11. package/dist/types/auth/AuthMiddleware.d.ts +12 -1
  12. package/dist/types/auth/AuthStrategy.d.ts +13 -1
  13. package/dist/types/auth/BasicStrategy.d.ts +7 -3
  14. package/dist/types/auth/JWTStrategy.d.ts +6 -3
  15. package/dist/types/index.d.ts +2 -1
  16. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md +1 -1
  17. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md +1 -1
  18. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md +1 -1
  19. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md +1 -1
  20. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md +1 -1
  21. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md +1 -1
  22. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md +1 -1
  23. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md +1 -1
  24. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md +1 -1
  25. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md +1 -1
  26. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md +1 -1
  27. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/TypeInfo.md +1 -1
  28. package/docs/reference/@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md +7 -7
  29. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/EventListener.md +1 -1
  30. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/OnEvent.md +1 -1
  31. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Cache.md +1 -1
  32. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/ChildEntity.md +1 -1
  33. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/DataStore.md +1 -1
  34. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Identifier.md +1 -1
  35. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Protect.md +1 -1
  36. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Reference.md +1 -1
  37. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Shard.md +1 -1
  38. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/TrackChanges.md +1 -1
  39. package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md +5 -5
  40. package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md +1 -1
  41. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md +1 -1
  42. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md +1 -1
  43. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md +3 -3
  44. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md +1 -1
  45. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Unique.md +3 -3
  46. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getColumnMetadata.md +1 -1
  47. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getEntityName.md +1 -1
  48. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getIndexMetadata.md +1 -1
  49. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md +4 -4
  50. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md +5 -5
  51. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md +4 -4
  52. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md +5 -5
  53. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/After.md +1 -1
  54. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Auth.md +1 -1
  55. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/AuthResult.md +1 -1
  56. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Before.md +1 -1
  57. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/ContentType.md +1 -1
  58. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Delete.md +1 -1
  59. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md +1 -1
  60. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md +1 -1
  61. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md +1 -1
  62. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md +1 -1
  63. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md +1 -1
  64. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md +1 -1
  65. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md +1 -1
  66. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md +1 -1
  67. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md +1 -1
  68. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md +1 -1
  69. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md +1 -1
  70. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md +1 -1
  71. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md +1 -1
  72. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md +1 -1
  73. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md +1 -1
  74. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md +1 -1
  75. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md +1 -1
  76. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md +1 -1
  77. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md +1 -1
  78. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md +1 -1
  79. package/docs/reference/classes/ACLUtils.md +10 -10
  80. package/docs/reference/classes/AdminRoute.md +3 -3
  81. package/docs/reference/classes/AuthMiddleware.md +55 -13
  82. package/docs/reference/classes/BackgroundService.md +8 -8
  83. package/docs/reference/classes/BackgroundServiceManager.md +7 -7
  84. package/docs/reference/classes/BaseEntity.md +6 -6
  85. package/docs/reference/classes/BaseMongoEntity.md +7 -7
  86. package/docs/reference/classes/BasicStrategy.md +52 -10
  87. package/docs/reference/classes/BasicStrategyOptions.md +35 -11
  88. package/docs/reference/classes/BulkError.md +3 -3
  89. package/docs/reference/classes/ConnectionManager.md +4 -4
  90. package/docs/reference/classes/EventListenerManager.md +5 -5
  91. package/docs/reference/classes/HttpRouter.md +343 -0
  92. package/docs/reference/classes/JWTStrategy.md +37 -14
  93. package/docs/reference/classes/JWTStrategyOptions.md +10 -10
  94. package/docs/reference/classes/MetricsRoute.md +2 -2
  95. package/docs/reference/classes/ModelRoute.md +28 -28
  96. package/docs/reference/classes/ModelUtils.md +10 -10
  97. package/docs/reference/classes/MongoConnection.md +12 -12
  98. package/docs/reference/classes/MongoRepository.md +17 -17
  99. package/docs/reference/classes/MongoSchemaSync.md +3 -3
  100. package/docs/reference/classes/NetUtils.md +4 -4
  101. package/docs/reference/classes/NotificationUtils.md +3 -3
  102. package/docs/reference/classes/ObjectFactory.md +10 -10
  103. package/docs/reference/classes/OpenAPIRoute.md +5 -5
  104. package/docs/reference/classes/OpenApiSpec.md +45 -45
  105. package/docs/reference/classes/RecoverableBaseEntity.md +7 -7
  106. package/docs/reference/classes/RecoverableBaseMongoEntity.md +8 -8
  107. package/docs/reference/classes/RedisTransport.md +4 -4
  108. package/docs/reference/classes/RepoUtils.md +28 -28
  109. package/docs/reference/classes/RouteUtils.md +17 -17
  110. package/docs/reference/classes/Server.md +29 -29
  111. package/docs/reference/classes/SimpleEntity.md +3 -3
  112. package/docs/reference/classes/SimpleMongoEntity.md +4 -4
  113. package/docs/reference/classes/StatusExtraData.md +4 -4
  114. package/docs/reference/classes/StatusRoute.md +1 -1
  115. package/docs/reference/classes/UWSRequest.md +226 -0
  116. package/docs/reference/classes/UWSResponse.md +257 -0
  117. package/docs/reference/classes/UWSWebSocketShim.md +958 -0
  118. package/docs/reference/enumerations/ACLAction.md +7 -7
  119. package/docs/reference/enumerations/ApiErrorMessages.md +15 -15
  120. package/docs/reference/enumerations/ApiErrors.md +15 -15
  121. package/docs/reference/functions/createWebSocketStream.md +27 -0
  122. package/docs/reference/functions/isSqlDataSource.md +1 -1
  123. package/docs/reference/functions/readBody.md +29 -0
  124. package/docs/reference/functions/resolveCollectionName.md +1 -1
  125. package/docs/reference/functions/runChain.md +40 -0
  126. package/docs/reference/functions/snakeCase.md +1 -1
  127. package/docs/reference/globals.md +15 -0
  128. package/docs/reference/interfaces/ACLRecord.md +8 -8
  129. package/docs/reference/interfaces/AccessControlList.md +5 -5
  130. package/docs/reference/interfaces/AuthResult.md +5 -5
  131. package/docs/reference/interfaces/AuthStrategy.md +47 -9
  132. package/docs/reference/interfaces/CreateRequestOptions.md +11 -11
  133. package/docs/reference/interfaces/DeleteRequestOptions.md +13 -13
  134. package/docs/reference/interfaces/FindRequestOptions.md +12 -12
  135. package/docs/reference/interfaces/HttpRequest.md +147 -0
  136. package/docs/reference/interfaces/HttpResponse.md +164 -0
  137. package/docs/reference/interfaces/JWTAuthResult.md +9 -9
  138. package/docs/reference/interfaces/RepoCreateOptions.md +7 -7
  139. package/docs/reference/interfaces/RepoDeleteOptions.md +9 -9
  140. package/docs/reference/interfaces/RepoFindOptions.md +11 -11
  141. package/docs/reference/interfaces/RepoOperationOptions.md +6 -6
  142. package/docs/reference/interfaces/RepoUpdateOptions.md +8 -8
  143. package/docs/reference/interfaces/RequestOptions.md +10 -10
  144. package/docs/reference/interfaces/RequestWS.md +225 -0
  145. package/docs/reference/interfaces/TruncateRequestOptions.md +15 -15
  146. package/docs/reference/interfaces/UpdateRequestOptions.md +13 -13
  147. package/docs/reference/type-aliases/ErrorHandler.md +35 -0
  148. package/docs/reference/type-aliases/NextFunction.md +23 -0
  149. package/docs/reference/type-aliases/OneOrMany.md +1 -1
  150. package/docs/reference/type-aliases/OneOrNull.md +1 -1
  151. package/docs/reference/type-aliases/PartialBaseEntity.md +1 -1
  152. package/docs/reference/type-aliases/PartialSimpleEntity.md +1 -1
  153. package/docs/reference/type-aliases/RequestHandler.md +31 -0
  154. package/docs/reference/type-aliases/UpdateObject.md +1 -1
  155. package/docs/reference/type-aliases/WsUpgradeAuth.md +27 -0
  156. package/docs/reference/type-aliases/WsUpgradeAuthResult.md +47 -0
  157. package/package.json +2 -2
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: Server
8
8
 
9
- Defined in: [src/Server.ts:147](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L147)
9
+ Defined in: [src/Server.ts:147](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L147)
10
10
 
11
11
  Provides an HTTP server utilizing uWebSockets.js. The server automatically registers all routes, and
12
12
  establishes database connections for all configured data stores. Additionally provides automatic authentication
@@ -121,7 +121,7 @@ Jean-Philippe Steinmetz
121
121
 
122
122
  > **new Server**(`config`, `basePath?`, `logger?`, `objectFactory?`): `Server`
123
123
 
124
- Defined in: [src/Server.ts:209](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L209)
124
+ Defined in: [src/Server.ts:209](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L209)
125
125
 
126
126
  Creates a new instance of Server with the specified defaults.
127
127
 
@@ -161,7 +161,7 @@ The object factory to use for automatic dependency injection (IOC).
161
161
 
162
162
  > `protected` `optional` **apiSpec?**: [`OpenApiSpec`](OpenApiSpec.md)
163
163
 
164
- Defined in: [src/Server.ts:149](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L149)
164
+ Defined in: [src/Server.ts:149](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L149)
165
165
 
166
166
  The OpenAPI specification object to use to construct the server with.
167
167
 
@@ -169,9 +169,9 @@ The OpenAPI specification object to use to construct the server with.
169
169
 
170
170
  ### app
171
171
 
172
- > `protected` **app**: `HttpRouter`
172
+ > `protected` **app**: [`HttpRouter`](HttpRouter.md)
173
173
 
174
- Defined in: [src/Server.ts:151](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L151)
174
+ Defined in: [src/Server.ts:151](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L151)
175
175
 
176
176
  The underlying HTTP router (uWS-backed) that provides HTTP processing services.
177
177
 
@@ -181,7 +181,7 @@ The underlying HTTP router (uWS-backed) that provides HTTP processing services.
181
181
 
182
182
  > `protected` `readonly` **basePath**: `string`
183
183
 
184
- Defined in: [src/Server.ts:153](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L153)
184
+ Defined in: [src/Server.ts:153](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L153)
185
185
 
186
186
  The base file system path that will be searched for models and routes.
187
187
 
@@ -191,7 +191,7 @@ The base file system path that will be searched for models and routes.
191
191
 
192
192
  > `protected` `readonly` `optional` **config?**: `any`
193
193
 
194
- Defined in: [src/Server.ts:155](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L155)
194
+ Defined in: [src/Server.ts:155](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L155)
195
195
 
196
196
  The global object containing configuration information to use.
197
197
 
@@ -201,7 +201,7 @@ The global object containing configuration information to use.
201
201
 
202
202
  > `protected` `optional` **connectionManager?**: [`ConnectionManager`](ConnectionManager.md)
203
203
 
204
- Defined in: [src/Server.ts:157](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L157)
204
+ Defined in: [src/Server.ts:157](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L157)
205
205
 
206
206
  The manager for handling database connections.
207
207
 
@@ -211,7 +211,7 @@ The manager for handling database connections.
211
211
 
212
212
  > `protected` `optional` **eventListenerManager?**: [`EventListenerManager`](EventListenerManager.md)
213
213
 
214
- Defined in: [src/Server.ts:159](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L159)
214
+ Defined in: [src/Server.ts:159](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L159)
215
215
 
216
216
  The manager for handling events.
217
217
 
@@ -221,7 +221,7 @@ The manager for handling events.
221
221
 
222
222
  > `protected` `readonly` **logger**: `any`
223
223
 
224
- Defined in: [src/Server.ts:161](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L161)
224
+ Defined in: [src/Server.ts:161](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L161)
225
225
 
226
226
  The logging utility to use when outputing to console/file.
227
227
 
@@ -231,7 +231,7 @@ The logging utility to use when outputing to console/file.
231
231
 
232
232
  > `protected` **metricCompletedRequests**: `Counter`\<`string`\>
233
233
 
234
- Defined in: [src/Server.ts:188](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L188)
234
+ Defined in: [src/Server.ts:188](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L188)
235
235
 
236
236
  ***
237
237
 
@@ -239,7 +239,7 @@ Defined in: [src/Server.ts:188](https://github.com/rapidrest/service-core/blob/c
239
239
 
240
240
  > `protected` **metricFailedRequests**: `Counter`\<`string`\>
241
241
 
242
- Defined in: [src/Server.ts:192](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L192)
242
+ Defined in: [src/Server.ts:192](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L192)
243
243
 
244
244
  ***
245
245
 
@@ -247,7 +247,7 @@ Defined in: [src/Server.ts:192](https://github.com/rapidrest/service-core/blob/c
247
247
 
248
248
  > `protected` **metricRequestPath**: `Counter`\<`string`\>
249
249
 
250
- Defined in: [src/Server.ts:172](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L172)
250
+ Defined in: [src/Server.ts:172](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L172)
251
251
 
252
252
  ***
253
253
 
@@ -255,7 +255,7 @@ Defined in: [src/Server.ts:172](https://github.com/rapidrest/service-core/blob/c
255
255
 
256
256
  > `protected` **metricRequestStatus**: `Counter`\<`string`\>
257
257
 
258
- Defined in: [src/Server.ts:177](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L177)
258
+ Defined in: [src/Server.ts:177](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L177)
259
259
 
260
260
  ***
261
261
 
@@ -263,7 +263,7 @@ Defined in: [src/Server.ts:177](https://github.com/rapidrest/service-core/blob/c
263
263
 
264
264
  > `protected` **metricRequestTime**: `Histogram`\<`string`\>
265
265
 
266
- Defined in: [src/Server.ts:182](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L182)
266
+ Defined in: [src/Server.ts:182](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L182)
267
267
 
268
268
  ***
269
269
 
@@ -271,7 +271,7 @@ Defined in: [src/Server.ts:182](https://github.com/rapidrest/service-core/blob/c
271
271
 
272
272
  > `protected` **metricTotalRequests**: `Counter`\<`string`\>
273
273
 
274
- Defined in: [src/Server.ts:196](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L196)
274
+ Defined in: [src/Server.ts:196](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L196)
275
275
 
276
276
  ***
277
277
 
@@ -279,7 +279,7 @@ Defined in: [src/Server.ts:196](https://github.com/rapidrest/service-core/blob/c
279
279
 
280
280
  > `protected` `readonly` **objectFactory**: [`ObjectFactory`](ObjectFactory.md)
281
281
 
282
- Defined in: [src/Server.ts:163](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L163)
282
+ Defined in: [src/Server.ts:163](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L163)
283
283
 
284
284
  The object factory to use when injecting dependencies.
285
285
 
@@ -289,7 +289,7 @@ The object factory to use when injecting dependencies.
289
289
 
290
290
  > `readonly` **port**: `number`
291
291
 
292
- Defined in: [src/Server.ts:165](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L165)
292
+ Defined in: [src/Server.ts:165](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L165)
293
293
 
294
294
  The port that the server is listening on.
295
295
 
@@ -299,7 +299,7 @@ The port that the server is listening on.
299
299
 
300
300
  > `protected` `optional` **routeUtils?**: [`RouteUtils`](RouteUtils.md)
301
301
 
302
- Defined in: [src/Server.ts:166](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L166)
302
+ Defined in: [src/Server.ts:166](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L166)
303
303
 
304
304
  ***
305
305
 
@@ -307,21 +307,21 @@ Defined in: [src/Server.ts:166](https://github.com/rapidrest/service-core/blob/c
307
307
 
308
308
  > `protected` `optional` **serviceManager?**: [`BackgroundServiceManager`](BackgroundServiceManager.md)
309
309
 
310
- Defined in: [src/Server.ts:167](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L167)
310
+ Defined in: [src/Server.ts:167](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L167)
311
311
 
312
312
  ## Methods
313
313
 
314
314
  ### getApplication()
315
315
 
316
- > **getApplication**(): `HttpRouter`
316
+ > **getApplication**(): [`HttpRouter`](HttpRouter.md)
317
317
 
318
- Defined in: [src/Server.ts:220](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L220)
318
+ Defined in: [src/Server.ts:220](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L220)
319
319
 
320
320
  Returns the HTTP router instance.
321
321
 
322
322
  #### Returns
323
323
 
324
- `HttpRouter`
324
+ [`HttpRouter`](HttpRouter.md)
325
325
 
326
326
  ***
327
327
 
@@ -329,7 +329,7 @@ Returns the HTTP router instance.
329
329
 
330
330
  > **isRunning**(): `boolean`
331
331
 
332
- Defined in: [src/Server.ts:227](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L227)
332
+ Defined in: [src/Server.ts:227](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L227)
333
333
 
334
334
  Returns `true` if the server is running, otherwise `false`.
335
335
 
@@ -343,7 +343,7 @@ Returns `true` if the server is running, otherwise `false`.
343
343
 
344
344
  > `protected` **postStart**(): `void` \| `Promise`\<`void`\>
345
345
 
346
- Defined in: [src/Server.ts:241](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L241)
346
+ Defined in: [src/Server.ts:241](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L241)
347
347
 
348
348
  Override this function to add custom behavior after the server is started.
349
349
 
@@ -357,7 +357,7 @@ Override this function to add custom behavior after the server is started.
357
357
 
358
358
  > `protected` **preStart**(): `void` \| `Promise`\<`void`\>
359
359
 
360
- Defined in: [src/Server.ts:234](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L234)
360
+ Defined in: [src/Server.ts:234](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L234)
361
361
 
362
362
  Override this function to add custom behavior before the server is started.
363
363
 
@@ -371,7 +371,7 @@ Override this function to add custom behavior before the server is started.
371
371
 
372
372
  > **restart**(): `Promise`\<`void`\>
373
373
 
374
- Defined in: [src/Server.ts:622](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L622)
374
+ Defined in: [src/Server.ts:622](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L622)
375
375
 
376
376
  Restarts the HTTP listen server using the provided configuration and OpenAPI specification.
377
377
 
@@ -385,7 +385,7 @@ Restarts the HTTP listen server using the provided configuration and OpenAPI spe
385
385
 
386
386
  > **start**(): `Promise`\<`void`\>
387
387
 
388
- Defined in: [src/Server.ts:248](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L248)
388
+ Defined in: [src/Server.ts:248](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L248)
389
389
 
390
390
  Starts an HTTP listen server based on the provided configuration and OpenAPI specification.
391
391
 
@@ -399,7 +399,7 @@ Starts an HTTP listen server based on the provided configuration and OpenAPI spe
399
399
 
400
400
  > **stop**(): `Promise`\<`void`\>
401
401
 
402
- Defined in: [src/Server.ts:594](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/Server.ts#L594)
402
+ Defined in: [src/Server.ts:594](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/Server.ts#L594)
403
403
 
404
404
  Stops the HTTP listen server.
405
405
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Abstract Class: SimpleEntity
8
8
 
9
- Defined in: [src/models/SimpleEntity.ts:15](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleEntity.ts#L15)
9
+ Defined in: [src/models/SimpleEntity.ts:15](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/SimpleEntity.ts#L15)
10
10
 
11
11
  Provides a simple base class for all entity's that will be persisted with TypeORM. Unlike `BaseEntity` this class
12
12
  does not provide optimistic locking or date created and modified tracking.
@@ -25,7 +25,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
25
25
 
26
26
  > **new SimpleEntity**(`other?`): `SimpleEntity`
27
27
 
28
- Defined in: [src/models/SimpleEntity.ts:26](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleEntity.ts#L26)
28
+ Defined in: [src/models/SimpleEntity.ts:26](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/SimpleEntity.ts#L26)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -43,6 +43,6 @@ Defined in: [src/models/SimpleEntity.ts:26](https://github.com/rapidrest/service
43
43
 
44
44
  > **uid**: `string`
45
45
 
46
- Defined in: [src/models/SimpleEntity.ts:24](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleEntity.ts#L24)
46
+ Defined in: [src/models/SimpleEntity.ts:24](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/SimpleEntity.ts#L24)
47
47
 
48
48
  The universally unique identifier of the entity.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Abstract Class: SimpleMongoEntity
8
8
 
9
- Defined in: [src/models/SimpleMongoEntity.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleMongoEntity.ts#L14)
9
+ Defined in: [src/models/SimpleMongoEntity.ts:14](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/SimpleMongoEntity.ts#L14)
10
10
 
11
11
  Provides a simple base class for all entity's that will be persisted in a MongoDB database. Unlike
12
12
  `BaseMongoEntity` this class does not provide optimistic locking or date created and modified tracking.
@@ -25,7 +25,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
25
25
 
26
26
  > **new SimpleMongoEntity**(`other?`): `SimpleMongoEntity`
27
27
 
28
- Defined in: [src/models/SimpleMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleMongoEntity.ts#L21)
28
+ Defined in: [src/models/SimpleMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/SimpleMongoEntity.ts#L21)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -47,7 +47,7 @@ Defined in: [src/models/SimpleMongoEntity.ts:21](https://github.com/rapidrest/se
47
47
 
48
48
  > `optional` **\_id?**: `ObjectId`
49
49
 
50
- Defined in: [src/models/SimpleMongoEntity.ts:19](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleMongoEntity.ts#L19)
50
+ Defined in: [src/models/SimpleMongoEntity.ts:19](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/SimpleMongoEntity.ts#L19)
51
51
 
52
52
  The internal unique identifier used by MongoDB.
53
53
 
@@ -57,7 +57,7 @@ The internal unique identifier used by MongoDB.
57
57
 
58
58
  > **uid**: `string`
59
59
 
60
- Defined in: [src/models/SimpleEntity.ts:24](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/SimpleEntity.ts#L24)
60
+ Defined in: [src/models/SimpleEntity.ts:24](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/SimpleEntity.ts#L24)
61
61
 
62
62
  The universally unique identifier of the entity.
63
63
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: StatusExtraData
8
8
 
9
- Defined in: [src/models/StatusExtraData.ts:1](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/StatusExtraData.ts#L1)
9
+ Defined in: [src/models/StatusExtraData.ts:1](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/StatusExtraData.ts#L1)
10
10
 
11
11
  ## Constructors
12
12
 
@@ -14,7 +14,7 @@ Defined in: [src/models/StatusExtraData.ts:1](https://github.com/rapidrest/servi
14
14
 
15
15
  > **new StatusExtraData**(`other`): `StatusExtraData`
16
16
 
17
- Defined in: [src/models/StatusExtraData.ts:9](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/StatusExtraData.ts#L9)
17
+ Defined in: [src/models/StatusExtraData.ts:9](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/StatusExtraData.ts#L9)
18
18
 
19
19
  #### Parameters
20
20
 
@@ -34,7 +34,7 @@ Defined in: [src/models/StatusExtraData.ts:9](https://github.com/rapidrest/servi
34
34
 
35
35
  > **get** **data**(): `any`
36
36
 
37
- Defined in: [src/models/StatusExtraData.ts:3](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/StatusExtraData.ts#L3)
37
+ Defined in: [src/models/StatusExtraData.ts:3](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/StatusExtraData.ts#L3)
38
38
 
39
39
  ##### Returns
40
40
 
@@ -44,7 +44,7 @@ Defined in: [src/models/StatusExtraData.ts:3](https://github.com/rapidrest/servi
44
44
 
45
45
  > **set** **data**(`data`): `void`
46
46
 
47
- Defined in: [src/models/StatusExtraData.ts:6](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/StatusExtraData.ts#L6)
47
+ Defined in: [src/models/StatusExtraData.ts:6](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/StatusExtraData.ts#L6)
48
48
 
49
49
  ##### Parameters
50
50
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: StatusRoute
8
8
 
9
- Defined in: [src/routes/StatusRoute.ts:17](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/StatusRoute.ts#L17)
9
+ Defined in: [src/routes/StatusRoute.ts:17](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/StatusRoute.ts#L17)
10
10
 
11
11
  The `StatusRoute` provides a default `/status` endpoint the returns metadata information about the service such as
12
12
  name, version.
@@ -0,0 +1,226 @@
1
+ [**@rapidrest/service-core**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../globals.md) / UWSRequest
6
+
7
+ # Class: UWSRequest
8
+
9
+ Defined in: [src/http/Adapters.ts:58](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L58)
10
+
11
+ Adapts a uWS `HttpRequest` to the framework-agnostic `HttpRequest` interface.
12
+
13
+ IMPORTANT: uWS HttpRequest is stack-allocated and only valid during the synchronous portion of
14
+ the handler. All request data MUST be captured in the constructor before any `await`.
15
+
16
+ ## Implements
17
+
18
+ - [`HttpRequest`](../interfaces/HttpRequest.md)
19
+
20
+ ## Indexable
21
+
22
+ > \[`key`: `string`\]: `any`
23
+
24
+ Allow arbitrary per-request properties (websocket, wsHandled, etc.)
25
+
26
+ ## Constructors
27
+
28
+ ### Constructor
29
+
30
+ > **new UWSRequest**(`uwsReq`, `remoteAddress?`): `UWSRequest`
31
+
32
+ Defined in: [src/http/Adapters.ts:76](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L76)
33
+
34
+ #### Parameters
35
+
36
+ ##### uwsReq
37
+
38
+ `HttpRequest`
39
+
40
+ ##### remoteAddress?
41
+
42
+ `string`
43
+
44
+ #### Returns
45
+
46
+ `UWSRequest`
47
+
48
+ ## Properties
49
+
50
+ ### authPayload?
51
+
52
+ > `optional` **authPayload?**: `any`
53
+
54
+ Defined in: [src/http/Adapters.ts:71](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L71)
55
+
56
+ Full decoded JWT payload, set by JWT auth middleware.
57
+
58
+ #### Implementation of
59
+
60
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`authPayload`](../interfaces/HttpRequest.md#authpayload)
61
+
62
+ ***
63
+
64
+ ### authToken?
65
+
66
+ > `optional` **authToken?**: `string`
67
+
68
+ Defined in: [src/http/Adapters.ts:72](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L72)
69
+
70
+ Raw JWT token string, set by JWT auth middleware.
71
+
72
+ #### Implementation of
73
+
74
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`authToken`](../interfaces/HttpRequest.md#authtoken)
75
+
76
+ ***
77
+
78
+ ### body
79
+
80
+ > **body**: `any` = `undefined`
81
+
82
+ Defined in: [src/http/Adapters.ts:65](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L65)
83
+
84
+ #### Implementation of
85
+
86
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`body`](../interfaces/HttpRequest.md#body)
87
+
88
+ ***
89
+
90
+ ### cookies
91
+
92
+ > `readonly` **cookies**: `Record`\<`string`, `string`\>
93
+
94
+ Defined in: [src/http/Adapters.ts:67](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L67)
95
+
96
+ #### Implementation of
97
+
98
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`cookies`](../interfaces/HttpRequest.md#cookies)
99
+
100
+ ***
101
+
102
+ ### headers
103
+
104
+ > `readonly` **headers**: `Record`\<`string`, `string`\>
105
+
106
+ Defined in: [src/http/Adapters.ts:62](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L62)
107
+
108
+ #### Implementation of
109
+
110
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`headers`](../interfaces/HttpRequest.md#headers)
111
+
112
+ ***
113
+
114
+ ### method
115
+
116
+ > `readonly` **method**: `string`
117
+
118
+ Defined in: [src/http/Adapters.ts:59](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L59)
119
+
120
+ #### Implementation of
121
+
122
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`method`](../interfaces/HttpRequest.md#method)
123
+
124
+ ***
125
+
126
+ ### params
127
+
128
+ > **params**: `Record`\<`string`, `string`\> = `{}`
129
+
130
+ Defined in: [src/http/Adapters.ts:63](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L63)
131
+
132
+ #### Implementation of
133
+
134
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`params`](../interfaces/HttpRequest.md#params)
135
+
136
+ ***
137
+
138
+ ### path
139
+
140
+ > `readonly` **path**: `string`
141
+
142
+ Defined in: [src/http/Adapters.ts:61](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L61)
143
+
144
+ #### Implementation of
145
+
146
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`path`](../interfaces/HttpRequest.md#path)
147
+
148
+ ***
149
+
150
+ ### query
151
+
152
+ > `readonly` **query**: `Record`\<`string`, `string` \| `string`[]\>
153
+
154
+ Defined in: [src/http/Adapters.ts:64](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L64)
155
+
156
+ #### Implementation of
157
+
158
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`query`](../interfaces/HttpRequest.md#query)
159
+
160
+ ***
161
+
162
+ ### rawBody?
163
+
164
+ > `optional` **rawBody?**: `Buffer`\<`ArrayBufferLike`\>
165
+
166
+ Defined in: [src/http/Adapters.ts:66](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L66)
167
+
168
+ #### Implementation of
169
+
170
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`rawBody`](../interfaces/HttpRequest.md#rawbody)
171
+
172
+ ***
173
+
174
+ ### signedCookies
175
+
176
+ > `readonly` **signedCookies**: `Record`\<`string`, `string`\> = `{}`
177
+
178
+ Defined in: [src/http/Adapters.ts:68](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L68)
179
+
180
+ #### Implementation of
181
+
182
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`signedCookies`](../interfaces/HttpRequest.md#signedcookies)
183
+
184
+ ***
185
+
186
+ ### socket
187
+
188
+ > `readonly` **socket**: `object`
189
+
190
+ Defined in: [src/http/Adapters.ts:69](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L69)
191
+
192
+ Minimal socket interface; populated with remote address for IP extraction.
193
+
194
+ #### remoteAddress?
195
+
196
+ > `optional` **remoteAddress?**: `string`
197
+
198
+ #### Implementation of
199
+
200
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`socket`](../interfaces/HttpRequest.md#socket)
201
+
202
+ ***
203
+
204
+ ### url
205
+
206
+ > `readonly` **url**: `string`
207
+
208
+ Defined in: [src/http/Adapters.ts:60](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L60)
209
+
210
+ #### Implementation of
211
+
212
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`url`](../interfaces/HttpRequest.md#url)
213
+
214
+ ***
215
+
216
+ ### user?
217
+
218
+ > `optional` **user?**: `any`
219
+
220
+ Defined in: [src/http/Adapters.ts:70](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Adapters.ts#L70)
221
+
222
+ Set by JWT auth middleware after successful token verification.
223
+
224
+ #### Implementation of
225
+
226
+ [`HttpRequest`](../interfaces/HttpRequest.md).[`user`](../interfaces/HttpRequest.md#user)