@rapidrest/service-core 1.0.0-beta.4 → 1.0.0-beta.5

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 (155) hide show
  1. package/dist/lib/Server.js +10 -10
  2. package/dist/lib/Server.js.map +1 -1
  3. package/dist/lib/auth/JWTStrategy.js +2 -1
  4. package/dist/lib/auth/JWTStrategy.js.map +1 -1
  5. package/dist/lib/http/Adapters.js +31 -20
  6. package/dist/lib/http/Adapters.js.map +1 -1
  7. package/dist/lib/http/Router.js +11 -4
  8. package/dist/lib/http/Router.js.map +1 -1
  9. package/dist/lib/routes/RouteUtils.js +10 -12
  10. package/dist/lib/routes/RouteUtils.js.map +1 -1
  11. package/dist/lib/security/ACLUtils.js +19 -3
  12. package/dist/lib/security/ACLUtils.js.map +1 -1
  13. package/dist/types/auth/JWTStrategy.d.ts +1 -0
  14. package/dist/types/security/ACLUtils.d.ts +1 -1
  15. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md +1 -1
  16. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md +1 -1
  17. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md +1 -1
  18. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md +1 -1
  19. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md +1 -1
  20. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md +1 -1
  21. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md +1 -1
  22. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md +1 -1
  23. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md +1 -1
  24. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md +1 -1
  25. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md +1 -1
  26. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/TypeInfo.md +1 -1
  27. package/docs/reference/@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md +7 -7
  28. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/EventListener.md +1 -1
  29. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/OnEvent.md +1 -1
  30. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Cache.md +1 -1
  31. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/ChildEntity.md +1 -1
  32. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/DataStore.md +1 -1
  33. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Identifier.md +1 -1
  34. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Protect.md +1 -1
  35. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Reference.md +1 -1
  36. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Shard.md +1 -1
  37. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/TrackChanges.md +1 -1
  38. package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md +5 -5
  39. package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md +1 -1
  40. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md +1 -1
  41. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md +1 -1
  42. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md +3 -3
  43. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md +1 -1
  44. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Unique.md +3 -3
  45. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getColumnMetadata.md +1 -1
  46. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getEntityName.md +1 -1
  47. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getIndexMetadata.md +1 -1
  48. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md +4 -4
  49. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md +5 -5
  50. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md +4 -4
  51. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md +5 -5
  52. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/After.md +1 -1
  53. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Auth.md +1 -1
  54. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/AuthResult.md +1 -1
  55. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Before.md +1 -1
  56. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/ContentType.md +1 -1
  57. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Delete.md +1 -1
  58. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md +1 -1
  59. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md +1 -1
  60. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md +1 -1
  61. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md +1 -1
  62. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md +1 -1
  63. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md +1 -1
  64. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md +1 -1
  65. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md +1 -1
  66. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md +1 -1
  67. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md +1 -1
  68. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md +1 -1
  69. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md +1 -1
  70. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md +1 -1
  71. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md +1 -1
  72. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md +1 -1
  73. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md +1 -1
  74. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md +1 -1
  75. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md +1 -1
  76. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md +1 -1
  77. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md +1 -1
  78. package/docs/reference/classes/ACLUtils.md +14 -10
  79. package/docs/reference/classes/AdminRoute.md +3 -3
  80. package/docs/reference/classes/AuthMiddleware.md +6 -6
  81. package/docs/reference/classes/BackgroundService.md +8 -8
  82. package/docs/reference/classes/BackgroundServiceManager.md +7 -7
  83. package/docs/reference/classes/BaseEntity.md +6 -6
  84. package/docs/reference/classes/BaseMongoEntity.md +7 -7
  85. package/docs/reference/classes/BasicStrategy.md +5 -5
  86. package/docs/reference/classes/BasicStrategyOptions.md +7 -7
  87. package/docs/reference/classes/BulkError.md +3 -3
  88. package/docs/reference/classes/ConnectionManager.md +4 -4
  89. package/docs/reference/classes/EventListenerManager.md +5 -5
  90. package/docs/reference/classes/HttpRouter.md +16 -16
  91. package/docs/reference/classes/JWTStrategy.md +10 -10
  92. package/docs/reference/classes/JWTStrategyOptions.md +10 -10
  93. package/docs/reference/classes/MetricsRoute.md +2 -2
  94. package/docs/reference/classes/ModelRoute.md +26 -26
  95. package/docs/reference/classes/ModelUtils.md +10 -10
  96. package/docs/reference/classes/MongoConnection.md +12 -12
  97. package/docs/reference/classes/MongoRepository.md +17 -17
  98. package/docs/reference/classes/MongoSchemaSync.md +3 -3
  99. package/docs/reference/classes/NetUtils.md +3 -3
  100. package/docs/reference/classes/NotificationUtils.md +3 -3
  101. package/docs/reference/classes/ObjectFactory.md +3 -3
  102. package/docs/reference/classes/OpenAPIRoute.md +5 -5
  103. package/docs/reference/classes/OpenApiSpec.md +45 -45
  104. package/docs/reference/classes/RecoverableBaseEntity.md +7 -7
  105. package/docs/reference/classes/RecoverableBaseMongoEntity.md +8 -8
  106. package/docs/reference/classes/RedisTransport.md +4 -4
  107. package/docs/reference/classes/RepoUtils.md +28 -28
  108. package/docs/reference/classes/RouteUtils.md +9 -9
  109. package/docs/reference/classes/Server.md +89 -89
  110. package/docs/reference/classes/SimpleEntity.md +3 -3
  111. package/docs/reference/classes/SimpleMongoEntity.md +4 -4
  112. package/docs/reference/classes/StatusExtraData.md +4 -4
  113. package/docs/reference/classes/StatusRoute.md +1 -1
  114. package/docs/reference/classes/UWSRequest.md +17 -17
  115. package/docs/reference/classes/UWSResponse.md +15 -15
  116. package/docs/reference/classes/UWSWebSocketShim.md +5 -5
  117. package/docs/reference/enumerations/ACLAction.md +7 -7
  118. package/docs/reference/enumerations/ApiErrorMessages.md +15 -15
  119. package/docs/reference/enumerations/ApiErrors.md +15 -15
  120. package/docs/reference/functions/createWebSocketStream.md +1 -1
  121. package/docs/reference/functions/isSqlDataSource.md +1 -1
  122. package/docs/reference/functions/readBody.md +3 -3
  123. package/docs/reference/functions/resolveCollectionName.md +1 -1
  124. package/docs/reference/functions/runChain.md +1 -1
  125. package/docs/reference/functions/snakeCase.md +1 -1
  126. package/docs/reference/interfaces/ACLRecord.md +8 -8
  127. package/docs/reference/interfaces/AccessControlList.md +5 -5
  128. package/docs/reference/interfaces/AuthResult.md +5 -5
  129. package/docs/reference/interfaces/AuthStrategy.md +4 -4
  130. package/docs/reference/interfaces/CreateRequestOptions.md +9 -9
  131. package/docs/reference/interfaces/DeleteRequestOptions.md +11 -11
  132. package/docs/reference/interfaces/FindRequestOptions.md +10 -10
  133. package/docs/reference/interfaces/HttpRequest.md +15 -15
  134. package/docs/reference/interfaces/HttpResponse.md +11 -11
  135. package/docs/reference/interfaces/JWTAuthResult.md +9 -9
  136. package/docs/reference/interfaces/RepoCreateOptions.md +7 -7
  137. package/docs/reference/interfaces/RepoDeleteOptions.md +9 -9
  138. package/docs/reference/interfaces/RepoFindOptions.md +11 -11
  139. package/docs/reference/interfaces/RepoOperationOptions.md +6 -6
  140. package/docs/reference/interfaces/RepoUpdateOptions.md +8 -8
  141. package/docs/reference/interfaces/RequestOptions.md +8 -8
  142. package/docs/reference/interfaces/RequestWS.md +17 -17
  143. package/docs/reference/interfaces/TruncateRequestOptions.md +13 -13
  144. package/docs/reference/interfaces/UpdateRequestOptions.md +11 -11
  145. package/docs/reference/type-aliases/ErrorHandler.md +1 -1
  146. package/docs/reference/type-aliases/NextFunction.md +1 -1
  147. package/docs/reference/type-aliases/OneOrMany.md +1 -1
  148. package/docs/reference/type-aliases/OneOrNull.md +1 -1
  149. package/docs/reference/type-aliases/PartialBaseEntity.md +1 -1
  150. package/docs/reference/type-aliases/PartialSimpleEntity.md +1 -1
  151. package/docs/reference/type-aliases/RequestHandler.md +1 -1
  152. package/docs/reference/type-aliases/UpdateObject.md +1 -1
  153. package/docs/reference/type-aliases/WsUpgradeAuth.md +1 -1
  154. package/docs/reference/type-aliases/WsUpgradeAuthResult.md +5 -5
  155. package/package.json +129 -125
@@ -6,109 +6,109 @@
6
6
 
7
7
  # Class: Server
8
8
 
9
- Defined in: [src/Server.ts:147](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L147)
9
+ Defined in: [src/Server.ts:147](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/Server.ts#L147)
10
10
 
11
- Provides an HTTP server utilizing uWebSockets.js. The server automatically registers all routes, and
12
- establishes database connections for all configured data stores. Additionally provides automatic authentication
13
- handling using JSON Web Token (JWT) directly — no Passport dependency required. When provided an OpenAPI
11
+ Provides an HTTP server utilizing uWebSockets.js. The server automatically registers all routes, and
12
+ establishes database connections for all configured data stores. Additionally provides automatic authentication
13
+ handling using JSON Web Token (JWT) directly — no Passport dependency required. When provided an OpenAPI
14
14
  specification object the server will also automatically serve this specification via the `GET /openapi.json` route.
15
15
 
16
- Routes are defined by creating any class definition using the various decorators found in `RouteDecorators` and
17
- saving these files in the `routes` subfolder. Upon server start, the `routes` folder is scanned for any class
18
- that has been decorated with `@Route` and is automatically loaded and registered. Similarly, if the
19
- class is decorated with the `@Model` decorator the resulting route object will have the associated data model
16
+ Routes are defined by creating any class definition using the various decorators found in `RouteDecorators` and
17
+ saving these files in the `routes` subfolder. Upon server start, the `routes` folder is scanned for any class
18
+ that has been decorated with `@Route` and is automatically loaded and registered. Similarly, if the
19
+ class is decorated with the `@Model` decorator the resulting route object will have the associated data model
20
20
  definition object injected into the constructor.
21
21
 
22
- SSL termination is supported by providing an `ssl` configuration block with `key`, `cert`, and optionally
22
+ SSL termination is supported by providing an `ssl` configuration block with `key`, `cert`, and optionally
23
23
  `ca` and `passphrase` file paths. When `ssl` is present the server uses `uWS.SSLApp()`.
24
24
 
25
25
  IPv6 is supported by setting `listen_host` to `"::"` in configuration (default `"0.0.0.0"`).
26
26
 
27
- By default all registered endpoints that do not explicitly have an `@Auth` decorator have the `JWT`
28
- authentication strategy applied. This allows users to be implicitly authenticated without requiring additional
29
- configuration. Once authenticated, the provided `request` argument will have the `user` property available
30
- containing information about the authenticated user. If the `user` property is `undefined` then no user has
27
+ By default all registered endpoints that do not explicitly have an `@Auth` decorator have the `JWT`
28
+ authentication strategy applied. This allows users to be implicitly authenticated without requiring additional
29
+ configuration. Once authenticated, the provided `request` argument will have the `user` property available
30
+ containing information about the authenticated user. If the `user` property is `undefined` then no user has
31
31
  been authenticated or the authentication attempt failed.
32
32
 
33
33
  The following is an example of a simple route class.
34
34
 
35
- ```javascript
36
- import { DefaultBehaviors, RouteDecorators } from "@rapidrest/service-core";
35
+ ```javascript
36
+ import { DefaultBehaviors, RouteDecorators } from "@rapidrest/service-core";
37
37
  import { Get, Route } = RouteDecorators;
38
38
 
39
- @Route("/hello")
40
- class TestRoute extends ModelRoute {
41
- constructor(model: any) {
42
- super(model);
39
+ @Route("/hello")
40
+ class TestRoute extends ModelRoute {
41
+ constructor(model: any) {
42
+ super(model);
43
43
  }
44
44
 
45
- @Get()
46
- count(req: any, res: any, next: Function): any {
47
- return res.send("Hello World!");
48
- }
45
+ @Get()
46
+ count(req: any, res: any, next: Function): any {
47
+ return res.send("Hello World!");
48
+ }
49
49
  }
50
50
 
51
- export default TestRoute;
51
+ export default TestRoute;
52
52
  ```
53
53
 
54
54
  The following is an example of a route class that is bound to a data model providing basic CRUDS operations.
55
55
 
56
- ```javascript
57
- import { DefaultBehaviors, ModelDecorators, ModelRoute, RouteDecorators } from "@rapidrest/service-core";
58
- import { After, Before, Delete, Get, Post, Put, Route, Validate } = RouteDecorators;
59
- import { Model } = ModelDecorators;
56
+ ```javascript
57
+ import { DefaultBehaviors, ModelDecorators, ModelRoute, RouteDecorators } from "@rapidrest/service-core";
58
+ import { After, Before, Delete, Get, Post, Put, Route, Validate } = RouteDecorators;
59
+ import { Model } = ModelDecorators;
60
60
  import { marshall } = DefaultBehaviors;
61
61
 
62
- @Model("Item")
63
- @Route("/items")
64
- class ItemRoute extends ModelRoute {
65
- constructor(model: any) {
66
- super(model);
62
+ @Model("Item")
63
+ @Route("/items")
64
+ class ItemRoute extends ModelRoute {
65
+ constructor(model: any) {
66
+ super(model);
67
67
  }
68
68
 
69
- @Get()
70
- @Before(super.count)
71
- @After(marshall)
72
- count(req: any, res: any, next: Function): any {
73
- return next();
69
+ @Get()
70
+ @Before(super.count)
71
+ @After(marshall)
72
+ count(req: any, res: any, next: Function): any {
73
+ return next();
74
74
  }
75
75
 
76
- @Post()
77
- @Before([super.create])
78
- @After([this.prepare, marshall])
79
- create(req: any, res: any, next: Function): any {
80
- return next();
76
+ @Post()
77
+ @Before([super.create])
78
+ @After([this.prepare, marshall])
79
+ create(req: any, res: any, next: Function): any {
80
+ return next();
81
81
  }
82
82
 
83
- @Delete(":id")
84
- @Before([super.delete])
85
- delete(req: any, res: any, next: Function): any {
86
- return next();
83
+ @Delete(":id")
84
+ @Before([super.delete])
85
+ delete(req: any, res: any, next: Function): any {
86
+ return next();
87
87
  }
88
88
 
89
- @Get()
90
- @Before([super.findAll])
91
- @After(this.prepareAndSend)
92
- findAll(req: any, res: any, next: Function): any {
93
- return next();
89
+ @Get()
90
+ @Before([super.findAll])
91
+ @After(this.prepareAndSend)
92
+ findAll(req: any, res: any, next: Function): any {
93
+ return next();
94
94
  }
95
95
 
96
- @Get(":id")
97
- @Before([super.findById])
98
- @After([this.prepare, marshall])
99
- findById(req: any, res: any, next: Function): any {
100
- return next();
96
+ @Get(":id")
97
+ @Before([super.findById])
98
+ @After([this.prepare, marshall])
99
+ findById(req: any, res: any, next: Function): any {
100
+ return next();
101
101
  }
102
102
 
103
- @Put(":id")
104
- @Before([super.update])
105
- @After([this.prepare, marshall])
106
- update(req: any, res: any, next: Function): any {
107
- return next();
108
- }
103
+ @Put(":id")
104
+ @Before([super.update])
105
+ @After([this.prepare, marshall])
106
+ update(req: any, res: any, next: Function): any {
107
+ return next();
108
+ }
109
109
  }
110
110
 
111
- export default ItemRoute;
111
+ export default ItemRoute;
112
112
  ```
113
113
 
114
114
  ## Author
@@ -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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L209)
124
+ Defined in: [src/Server.ts:209](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L149)
164
+ Defined in: [src/Server.ts:149](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/Server.ts#L149)
165
165
 
166
166
  The OpenAPI specification object to use to construct the server with.
167
167
 
@@ -171,7 +171,7 @@ The OpenAPI specification object to use to construct the server with.
171
171
 
172
172
  > `protected` **app**: [`HttpRouter`](HttpRouter.md)
173
173
 
174
- Defined in: [src/Server.ts:151](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L151)
174
+ Defined in: [src/Server.ts:151](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L153)
184
+ Defined in: [src/Server.ts:153](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L155)
194
+ Defined in: [src/Server.ts:155](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L157)
204
+ Defined in: [src/Server.ts:157](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L159)
214
+ Defined in: [src/Server.ts:159](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L161)
224
+ Defined in: [src/Server.ts:161](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L188)
234
+ Defined in: [src/Server.ts:188](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/a
239
239
 
240
240
  > `protected` **metricFailedRequests**: `Counter`\<`string`\>
241
241
 
242
- Defined in: [src/Server.ts:192](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L192)
242
+ Defined in: [src/Server.ts:192](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/a
247
247
 
248
248
  > `protected` **metricRequestPath**: `Counter`\<`string`\>
249
249
 
250
- Defined in: [src/Server.ts:172](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L172)
250
+ Defined in: [src/Server.ts:172](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/a
255
255
 
256
256
  > `protected` **metricRequestStatus**: `Counter`\<`string`\>
257
257
 
258
- Defined in: [src/Server.ts:177](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L177)
258
+ Defined in: [src/Server.ts:177](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/a
263
263
 
264
264
  > `protected` **metricRequestTime**: `Histogram`\<`string`\>
265
265
 
266
- Defined in: [src/Server.ts:182](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L182)
266
+ Defined in: [src/Server.ts:182](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/a
271
271
 
272
272
  > `protected` **metricTotalRequests**: `Counter`\<`string`\>
273
273
 
274
- Defined in: [src/Server.ts:196](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L196)
274
+ Defined in: [src/Server.ts:196](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/a
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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L163)
282
+ Defined in: [src/Server.ts:163](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L165)
292
+ Defined in: [src/Server.ts:165](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L166)
302
+ Defined in: [src/Server.ts:166](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/Server.ts#L166)
303
303
 
304
304
  ***
305
305
 
@@ -307,7 +307,7 @@ Defined in: [src/Server.ts:166](https://github.com/rapidrest/service-core/blob/a
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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L167)
310
+ Defined in: [src/Server.ts:167](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/Server.ts#L167)
311
311
 
312
312
  ## Methods
313
313
 
@@ -315,7 +315,7 @@ Defined in: [src/Server.ts:167](https://github.com/rapidrest/service-core/blob/a
315
315
 
316
316
  > **getApplication**(): [`HttpRouter`](HttpRouter.md)
317
317
 
318
- Defined in: [src/Server.ts:220](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L220)
318
+ Defined in: [src/Server.ts:220](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/Server.ts#L220)
319
319
 
320
320
  Returns the HTTP router instance.
321
321
 
@@ -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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L227)
332
+ Defined in: [src/Server.ts:227](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L241)
346
+ Defined in: [src/Server.ts:241](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L234)
360
+ Defined in: [src/Server.ts:234](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L622)
374
+ Defined in: [src/Server.ts:622](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L248)
388
+ Defined in: [src/Server.ts:248](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/Server.ts#L594)
402
+ Defined in: [src/Server.ts:594](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/models/SimpleEntity.ts#L15)
9
+ Defined in: [src/models/SimpleEntity.ts:15](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/models/SimpleEntity.ts#L26)
28
+ Defined in: [src/models/SimpleEntity.ts:26](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/models/SimpleEntity.ts#L24)
46
+ Defined in: [src/models/SimpleEntity.ts:24](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/models/SimpleMongoEntity.ts#L14)
9
+ Defined in: [src/models/SimpleMongoEntity.ts:14](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/models/SimpleMongoEntity.ts#L21)
28
+ Defined in: [src/models/SimpleMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/models/SimpleMongoEntity.ts#L19)
50
+ Defined in: [src/models/SimpleMongoEntity.ts:19](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/models/SimpleEntity.ts#L24)
60
+ Defined in: [src/models/SimpleEntity.ts:24](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/models/StatusExtraData.ts#L1)
9
+ Defined in: [src/models/StatusExtraData.ts:1](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/models/StatusExtraData.ts#L9)
17
+ Defined in: [src/models/StatusExtraData.ts:9](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/models/StatusExtraData.ts#L3)
37
+ Defined in: [src/models/StatusExtraData.ts:3](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/models/StatusExtraData.ts#L6)
47
+ Defined in: [src/models/StatusExtraData.ts:6](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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/ab54834688bebfbea1d8258c626822205861b919/src/routes/StatusRoute.ts#L17)
9
+ Defined in: [src/routes/StatusRoute.ts:17](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/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.
@@ -6,11 +6,11 @@
6
6
 
7
7
  # Class: UWSRequest
8
8
 
9
- Defined in: [src/http/Adapters.ts:58](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L58)
9
+ Defined in: [src/http/Adapters.ts:58](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L58)
10
10
 
11
11
  Adapts a uWS `HttpRequest` to the framework-agnostic `HttpRequest` interface.
12
12
 
13
- IMPORTANT: uWS HttpRequest is stack-allocated and only valid during the synchronous portion of
13
+ IMPORTANT: uWS HttpRequest is stack-allocated and only valid during the synchronous portion of
14
14
  the handler. All request data MUST be captured in the constructor before any `await`.
15
15
 
16
16
  ## Implements
@@ -29,7 +29,7 @@ Allow arbitrary per-request properties (websocket, wsHandled, etc.)
29
29
 
30
30
  > **new UWSRequest**(`uwsReq`, `remoteAddress?`): `UWSRequest`
31
31
 
32
- Defined in: [src/http/Adapters.ts:76](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L76)
32
+ Defined in: [src/http/Adapters.ts:76](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L76)
33
33
 
34
34
  #### Parameters
35
35
 
@@ -51,7 +51,7 @@ Defined in: [src/http/Adapters.ts:76](https://github.com/rapidrest/service-core/
51
51
 
52
52
  > `optional` **authPayload?**: `any`
53
53
 
54
- Defined in: [src/http/Adapters.ts:71](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L71)
54
+ Defined in: [src/http/Adapters.ts:71](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L71)
55
55
 
56
56
  Full decoded JWT payload, set by JWT auth middleware.
57
57
 
@@ -65,7 +65,7 @@ Full decoded JWT payload, set by JWT auth middleware.
65
65
 
66
66
  > `optional` **authToken?**: `string`
67
67
 
68
- Defined in: [src/http/Adapters.ts:72](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L72)
68
+ Defined in: [src/http/Adapters.ts:72](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L72)
69
69
 
70
70
  Raw JWT token string, set by JWT auth middleware.
71
71
 
@@ -79,7 +79,7 @@ Raw JWT token string, set by JWT auth middleware.
79
79
 
80
80
  > **body**: `any` = `undefined`
81
81
 
82
- Defined in: [src/http/Adapters.ts:65](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L65)
82
+ Defined in: [src/http/Adapters.ts:65](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L65)
83
83
 
84
84
  #### Implementation of
85
85
 
@@ -91,7 +91,7 @@ Defined in: [src/http/Adapters.ts:65](https://github.com/rapidrest/service-core/
91
91
 
92
92
  > `readonly` **cookies**: `Record`\<`string`, `string`\>
93
93
 
94
- Defined in: [src/http/Adapters.ts:67](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L67)
94
+ Defined in: [src/http/Adapters.ts:67](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L67)
95
95
 
96
96
  #### Implementation of
97
97
 
@@ -103,7 +103,7 @@ Defined in: [src/http/Adapters.ts:67](https://github.com/rapidrest/service-core/
103
103
 
104
104
  > `readonly` **headers**: `Record`\<`string`, `string`\>
105
105
 
106
- Defined in: [src/http/Adapters.ts:62](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L62)
106
+ Defined in: [src/http/Adapters.ts:62](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L62)
107
107
 
108
108
  #### Implementation of
109
109
 
@@ -115,7 +115,7 @@ Defined in: [src/http/Adapters.ts:62](https://github.com/rapidrest/service-core/
115
115
 
116
116
  > `readonly` **method**: `string`
117
117
 
118
- Defined in: [src/http/Adapters.ts:59](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L59)
118
+ Defined in: [src/http/Adapters.ts:59](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L59)
119
119
 
120
120
  #### Implementation of
121
121
 
@@ -127,7 +127,7 @@ Defined in: [src/http/Adapters.ts:59](https://github.com/rapidrest/service-core/
127
127
 
128
128
  > **params**: `Record`\<`string`, `string`\> = `{}`
129
129
 
130
- Defined in: [src/http/Adapters.ts:63](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L63)
130
+ Defined in: [src/http/Adapters.ts:63](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L63)
131
131
 
132
132
  #### Implementation of
133
133
 
@@ -139,7 +139,7 @@ Defined in: [src/http/Adapters.ts:63](https://github.com/rapidrest/service-core/
139
139
 
140
140
  > `readonly` **path**: `string`
141
141
 
142
- Defined in: [src/http/Adapters.ts:61](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L61)
142
+ Defined in: [src/http/Adapters.ts:61](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L61)
143
143
 
144
144
  #### Implementation of
145
145
 
@@ -151,7 +151,7 @@ Defined in: [src/http/Adapters.ts:61](https://github.com/rapidrest/service-core/
151
151
 
152
152
  > `readonly` **query**: `Record`\<`string`, `string` \| `string`[]\>
153
153
 
154
- Defined in: [src/http/Adapters.ts:64](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L64)
154
+ Defined in: [src/http/Adapters.ts:64](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L64)
155
155
 
156
156
  #### Implementation of
157
157
 
@@ -163,7 +163,7 @@ Defined in: [src/http/Adapters.ts:64](https://github.com/rapidrest/service-core/
163
163
 
164
164
  > `optional` **rawBody?**: `Buffer`\<`ArrayBufferLike`\>
165
165
 
166
- Defined in: [src/http/Adapters.ts:66](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L66)
166
+ Defined in: [src/http/Adapters.ts:66](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L66)
167
167
 
168
168
  #### Implementation of
169
169
 
@@ -175,7 +175,7 @@ Defined in: [src/http/Adapters.ts:66](https://github.com/rapidrest/service-core/
175
175
 
176
176
  > `readonly` **signedCookies**: `Record`\<`string`, `string`\> = `{}`
177
177
 
178
- Defined in: [src/http/Adapters.ts:68](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L68)
178
+ Defined in: [src/http/Adapters.ts:68](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L68)
179
179
 
180
180
  #### Implementation of
181
181
 
@@ -187,7 +187,7 @@ Defined in: [src/http/Adapters.ts:68](https://github.com/rapidrest/service-core/
187
187
 
188
188
  > `readonly` **socket**: `object`
189
189
 
190
- Defined in: [src/http/Adapters.ts:69](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L69)
190
+ Defined in: [src/http/Adapters.ts:69](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L69)
191
191
 
192
192
  Minimal socket interface; populated with remote address for IP extraction.
193
193
 
@@ -205,7 +205,7 @@ Minimal socket interface; populated with remote address for IP extraction.
205
205
 
206
206
  > `readonly` **url**: `string`
207
207
 
208
- Defined in: [src/http/Adapters.ts:60](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L60)
208
+ Defined in: [src/http/Adapters.ts:60](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L60)
209
209
 
210
210
  #### Implementation of
211
211
 
@@ -217,7 +217,7 @@ Defined in: [src/http/Adapters.ts:60](https://github.com/rapidrest/service-core/
217
217
 
218
218
  > `optional` **user?**: `any`
219
219
 
220
- Defined in: [src/http/Adapters.ts:70](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L70)
220
+ Defined in: [src/http/Adapters.ts:70](https://github.com/rapidrest/service-core/blob/4fdd657d7d387d4147d06ef5e46206995e846a87/src/http/Adapters.ts#L70)
221
221
 
222
222
  Set by JWT auth middleware after successful token verification.
223
223