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

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 (161) hide show
  1. package/dist/lib/Server.js +30 -24
  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/database/MongoSchemaSync.js +4 -4
  6. package/dist/lib/database/MongoSchemaSync.js.map +1 -1
  7. package/dist/lib/http/Adapters.js +31 -20
  8. package/dist/lib/http/Adapters.js.map +1 -1
  9. package/dist/lib/http/Router.js +11 -4
  10. package/dist/lib/http/Router.js.map +1 -1
  11. package/dist/lib/models/RepoUtils.js +17 -15
  12. package/dist/lib/models/RepoUtils.js.map +1 -1
  13. package/dist/lib/routes/ModelRoute.js +5 -4
  14. package/dist/lib/routes/ModelRoute.js.map +1 -1
  15. package/dist/lib/routes/RouteUtils.js +24 -18
  16. package/dist/lib/routes/RouteUtils.js.map +1 -1
  17. package/dist/lib/security/ACLUtils.js +62 -18
  18. package/dist/lib/security/ACLUtils.js.map +1 -1
  19. package/dist/types/auth/JWTStrategy.d.ts +1 -0
  20. package/dist/types/security/ACLUtils.d.ts +4 -1
  21. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md +1 -1
  22. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md +1 -1
  23. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md +1 -1
  24. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md +1 -1
  25. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md +1 -1
  26. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md +1 -1
  27. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md +1 -1
  28. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md +1 -1
  29. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md +1 -1
  30. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md +1 -1
  31. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md +1 -1
  32. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/TypeInfo.md +1 -1
  33. package/docs/reference/@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md +7 -7
  34. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/EventListener.md +1 -1
  35. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/OnEvent.md +1 -1
  36. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Cache.md +1 -1
  37. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/ChildEntity.md +1 -1
  38. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/DataStore.md +1 -1
  39. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Identifier.md +1 -1
  40. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Protect.md +1 -1
  41. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Reference.md +1 -1
  42. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Shard.md +1 -1
  43. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/TrackChanges.md +1 -1
  44. package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md +5 -5
  45. package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md +1 -1
  46. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md +1 -1
  47. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md +1 -1
  48. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md +3 -3
  49. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md +1 -1
  50. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Unique.md +3 -3
  51. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getColumnMetadata.md +1 -1
  52. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getEntityName.md +1 -1
  53. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getIndexMetadata.md +1 -1
  54. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md +4 -4
  55. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md +5 -5
  56. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md +4 -4
  57. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md +5 -5
  58. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/After.md +1 -1
  59. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Auth.md +1 -1
  60. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/AuthResult.md +1 -1
  61. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Before.md +1 -1
  62. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/ContentType.md +1 -1
  63. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Delete.md +1 -1
  64. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md +1 -1
  65. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md +1 -1
  66. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md +1 -1
  67. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md +1 -1
  68. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md +1 -1
  69. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md +1 -1
  70. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md +1 -1
  71. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md +1 -1
  72. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md +1 -1
  73. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md +1 -1
  74. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md +1 -1
  75. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md +1 -1
  76. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md +1 -1
  77. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md +1 -1
  78. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md +1 -1
  79. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md +1 -1
  80. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md +1 -1
  81. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md +1 -1
  82. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md +1 -1
  83. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md +1 -1
  84. package/docs/reference/classes/ACLUtils.md +22 -10
  85. package/docs/reference/classes/AdminRoute.md +3 -3
  86. package/docs/reference/classes/AuthMiddleware.md +8 -8
  87. package/docs/reference/classes/BackgroundService.md +8 -8
  88. package/docs/reference/classes/BackgroundServiceManager.md +7 -7
  89. package/docs/reference/classes/BaseEntity.md +6 -6
  90. package/docs/reference/classes/BaseMongoEntity.md +7 -7
  91. package/docs/reference/classes/BasicStrategy.md +5 -5
  92. package/docs/reference/classes/BasicStrategyOptions.md +7 -7
  93. package/docs/reference/classes/BulkError.md +3 -3
  94. package/docs/reference/classes/ConnectionManager.md +4 -4
  95. package/docs/reference/classes/EventListenerManager.md +5 -5
  96. package/docs/reference/classes/HttpRouter.md +16 -16
  97. package/docs/reference/classes/JWTStrategy.md +10 -10
  98. package/docs/reference/classes/JWTStrategyOptions.md +10 -10
  99. package/docs/reference/classes/MetricsRoute.md +2 -2
  100. package/docs/reference/classes/ModelRoute.md +26 -26
  101. package/docs/reference/classes/ModelUtils.md +10 -10
  102. package/docs/reference/classes/MongoConnection.md +12 -12
  103. package/docs/reference/classes/MongoRepository.md +17 -17
  104. package/docs/reference/classes/MongoSchemaSync.md +7 -7
  105. package/docs/reference/classes/NetUtils.md +3 -3
  106. package/docs/reference/classes/NotificationUtils.md +3 -3
  107. package/docs/reference/classes/ObjectFactory.md +3 -3
  108. package/docs/reference/classes/OpenAPIRoute.md +5 -5
  109. package/docs/reference/classes/OpenApiSpec.md +45 -45
  110. package/docs/reference/classes/RecoverableBaseEntity.md +7 -7
  111. package/docs/reference/classes/RecoverableBaseMongoEntity.md +8 -8
  112. package/docs/reference/classes/RedisTransport.md +4 -4
  113. package/docs/reference/classes/RepoUtils.md +35 -35
  114. package/docs/reference/classes/RouteUtils.md +9 -9
  115. package/docs/reference/classes/Server.md +89 -89
  116. package/docs/reference/classes/SimpleEntity.md +3 -3
  117. package/docs/reference/classes/SimpleMongoEntity.md +4 -4
  118. package/docs/reference/classes/StatusExtraData.md +4 -4
  119. package/docs/reference/classes/StatusRoute.md +1 -1
  120. package/docs/reference/classes/UWSRequest.md +17 -17
  121. package/docs/reference/classes/UWSResponse.md +15 -15
  122. package/docs/reference/classes/UWSWebSocketShim.md +5 -5
  123. package/docs/reference/enumerations/ACLAction.md +7 -7
  124. package/docs/reference/enumerations/ApiErrorMessages.md +15 -15
  125. package/docs/reference/enumerations/ApiErrors.md +15 -15
  126. package/docs/reference/functions/createWebSocketStream.md +1 -1
  127. package/docs/reference/functions/isSqlDataSource.md +1 -1
  128. package/docs/reference/functions/readBody.md +3 -3
  129. package/docs/reference/functions/resolveCollectionName.md +1 -1
  130. package/docs/reference/functions/runChain.md +1 -1
  131. package/docs/reference/functions/snakeCase.md +1 -1
  132. package/docs/reference/interfaces/ACLRecord.md +8 -8
  133. package/docs/reference/interfaces/AccessControlList.md +5 -5
  134. package/docs/reference/interfaces/AuthResult.md +5 -5
  135. package/docs/reference/interfaces/AuthStrategy.md +4 -4
  136. package/docs/reference/interfaces/CreateRequestOptions.md +9 -9
  137. package/docs/reference/interfaces/DeleteRequestOptions.md +11 -11
  138. package/docs/reference/interfaces/FindRequestOptions.md +10 -10
  139. package/docs/reference/interfaces/HttpRequest.md +15 -15
  140. package/docs/reference/interfaces/HttpResponse.md +11 -11
  141. package/docs/reference/interfaces/JWTAuthResult.md +9 -9
  142. package/docs/reference/interfaces/RepoCreateOptions.md +7 -7
  143. package/docs/reference/interfaces/RepoDeleteOptions.md +9 -9
  144. package/docs/reference/interfaces/RepoFindOptions.md +11 -11
  145. package/docs/reference/interfaces/RepoOperationOptions.md +6 -6
  146. package/docs/reference/interfaces/RepoUpdateOptions.md +8 -8
  147. package/docs/reference/interfaces/RequestOptions.md +8 -8
  148. package/docs/reference/interfaces/RequestWS.md +17 -17
  149. package/docs/reference/interfaces/TruncateRequestOptions.md +13 -13
  150. package/docs/reference/interfaces/UpdateRequestOptions.md +11 -11
  151. package/docs/reference/type-aliases/ErrorHandler.md +1 -1
  152. package/docs/reference/type-aliases/NextFunction.md +1 -1
  153. package/docs/reference/type-aliases/OneOrMany.md +1 -1
  154. package/docs/reference/type-aliases/OneOrNull.md +1 -1
  155. package/docs/reference/type-aliases/PartialBaseEntity.md +1 -1
  156. package/docs/reference/type-aliases/PartialSimpleEntity.md +1 -1
  157. package/docs/reference/type-aliases/RequestHandler.md +1 -1
  158. package/docs/reference/type-aliases/UpdateObject.md +1 -1
  159. package/docs/reference/type-aliases/WsUpgradeAuth.md +1 -1
  160. package/docs/reference/type-aliases/WsUpgradeAuthResult.md +5 -5
  161. package/package.json +129 -125
@@ -6,12 +6,12 @@
6
6
 
7
7
  # Class: UWSResponse
8
8
 
9
- Defined in: [src/http/Adapters.ts:109](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L109)
9
+ Defined in: [src/http/Adapters.ts:109](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L109)
10
10
 
11
11
  Adapts a uWS `HttpResponse` to the framework-agnostic `HttpResponse` interface.
12
12
 
13
- Buffers headers and status code until the first write. Tracks abort state to safely
14
- skip writes on aborted connections. All uWS writes are wrapped in `res.cork()` for
13
+ Buffers headers and status code until the first write. Tracks abort state to safely
14
+ skip writes on aborted connections. All uWS writes are wrapped in `res.cork()` for
15
15
  optimal performance.
16
16
 
17
17
  ## Implements
@@ -30,7 +30,7 @@ Allow arbitrary per-response properties.
30
30
 
31
31
  > **new UWSResponse**(`uwsRes`): `UWSResponse`
32
32
 
33
- Defined in: [src/http/Adapters.ts:123](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L123)
33
+ Defined in: [src/http/Adapters.ts:123](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L123)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -48,7 +48,7 @@ Defined in: [src/http/Adapters.ts:123](https://github.com/rapidrest/service-core
48
48
 
49
49
  > **isHead**: `boolean` = `false`
50
50
 
51
- Defined in: [src/http/Adapters.ts:117](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L117)
51
+ Defined in: [src/http/Adapters.ts:117](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L117)
52
52
 
53
53
  Set to true for HEAD requests — body bytes must not be sent.
54
54
 
@@ -58,7 +58,7 @@ Set to true for HEAD requests — body bytes must not be sent.
58
58
 
59
59
  > `optional` **result?**: `any`
60
60
 
61
- Defined in: [src/http/Adapters.ts:119](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L119)
61
+ Defined in: [src/http/Adapters.ts:119](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L119)
62
62
 
63
63
  Intermediate result passed between middleware.
64
64
 
@@ -74,7 +74,7 @@ Intermediate result passed between middleware.
74
74
 
75
75
  > **get** **headersSent**(): `boolean`
76
76
 
77
- Defined in: [src/http/Adapters.ts:135](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L135)
77
+ Defined in: [src/http/Adapters.ts:135](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L135)
78
78
 
79
79
  ##### Returns
80
80
 
@@ -92,7 +92,7 @@ Defined in: [src/http/Adapters.ts:135](https://github.com/rapidrest/service-core
92
92
 
93
93
  > **get** **statusCode**(): `number`
94
94
 
95
- Defined in: [src/http/Adapters.ts:131](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L131)
95
+ Defined in: [src/http/Adapters.ts:131](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L131)
96
96
 
97
97
  ##### Returns
98
98
 
@@ -110,7 +110,7 @@ Defined in: [src/http/Adapters.ts:131](https://github.com/rapidrest/service-core
110
110
 
111
111
  > **get** **writableEnded**(): `boolean`
112
112
 
113
- Defined in: [src/http/Adapters.ts:139](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L139)
113
+ Defined in: [src/http/Adapters.ts:139](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L139)
114
114
 
115
115
  ##### Returns
116
116
 
@@ -126,7 +126,7 @@ Defined in: [src/http/Adapters.ts:139](https://github.com/rapidrest/service-core
126
126
 
127
127
  > **end**(`data?`): `void`
128
128
 
129
- Defined in: [src/http/Adapters.ts:172](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L172)
129
+ Defined in: [src/http/Adapters.ts:172](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L172)
130
130
 
131
131
  #### Parameters
132
132
 
@@ -148,7 +148,7 @@ Defined in: [src/http/Adapters.ts:172](https://github.com/rapidrest/service-core
148
148
 
149
149
  > **getHeader**(`key`): `string` \| `undefined`
150
150
 
151
- Defined in: [src/http/Adapters.ts:153](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L153)
151
+ Defined in: [src/http/Adapters.ts:153](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L153)
152
152
 
153
153
  #### Parameters
154
154
 
@@ -170,7 +170,7 @@ Defined in: [src/http/Adapters.ts:153](https://github.com/rapidrest/service-core
170
170
 
171
171
  > **json**(`data`): `void`
172
172
 
173
- Defined in: [src/http/Adapters.ts:157](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L157)
173
+ Defined in: [src/http/Adapters.ts:157](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L157)
174
174
 
175
175
  #### Parameters
176
176
 
@@ -192,7 +192,7 @@ Defined in: [src/http/Adapters.ts:157](https://github.com/rapidrest/service-core
192
192
 
193
193
  > **send**(`data?`): `void`
194
194
 
195
- Defined in: [src/http/Adapters.ts:162](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L162)
195
+ Defined in: [src/http/Adapters.ts:162](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L162)
196
196
 
197
197
  #### Parameters
198
198
 
@@ -214,7 +214,7 @@ Defined in: [src/http/Adapters.ts:162](https://github.com/rapidrest/service-core
214
214
 
215
215
  > **setHeader**(`key`, `value`): `this`
216
216
 
217
- Defined in: [src/http/Adapters.ts:148](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L148)
217
+ Defined in: [src/http/Adapters.ts:148](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L148)
218
218
 
219
219
  #### Parameters
220
220
 
@@ -240,7 +240,7 @@ Defined in: [src/http/Adapters.ts:148](https://github.com/rapidrest/service-core
240
240
 
241
241
  > **status**(`code`): `this`
242
242
 
243
- Defined in: [src/http/Adapters.ts:143](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L143)
243
+ Defined in: [src/http/Adapters.ts:143](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L143)
244
244
 
245
245
  #### Parameters
246
246
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: UWSWebSocketShim
8
8
 
9
- Defined in: [src/http/WebSocket.ts:40](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/WebSocket.ts#L40)
9
+ Defined in: [src/http/WebSocket.ts:40](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/WebSocket.ts#L40)
10
10
 
11
11
  Wraps a uWS `WebSocket` handle and exposes an EventEmitter-based API compatible
12
12
  with what route handlers (e.g. `AdminRoute`) expect.
@@ -29,7 +29,7 @@ behavior callbacks can call `shim.emit(...)`.
29
29
 
30
30
  > **new UWSWebSocketShim**(`ws`): `UWSWebSocketShim`
31
31
 
32
- Defined in: [src/http/WebSocket.ts:44](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/WebSocket.ts#L44)
32
+ Defined in: [src/http/WebSocket.ts:44](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/WebSocket.ts#L44)
33
33
 
34
34
  #### Parameters
35
35
 
@@ -51,7 +51,7 @@ Defined in: [src/http/WebSocket.ts:44](https://github.com/rapidrest/service-core
51
51
 
52
52
  > **readyState**: `number` = `1`
53
53
 
54
- Defined in: [src/http/WebSocket.ts:42](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/WebSocket.ts#L42)
54
+ Defined in: [src/http/WebSocket.ts:42](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/WebSocket.ts#L42)
55
55
 
56
56
  ## Methods
57
57
 
@@ -156,7 +156,7 @@ v0.1.26
156
156
 
157
157
  > **close**(`code?`, `reason?`): `void`
158
158
 
159
- Defined in: [src/http/WebSocket.ts:69](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/WebSocket.ts#L69)
159
+ Defined in: [src/http/WebSocket.ts:69](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/WebSocket.ts#L69)
160
160
 
161
161
  Closes the WebSocket connection with an optional code and reason.
162
162
 
@@ -901,7 +901,7 @@ v0.1.26
901
901
 
902
902
  > **send**(`data`, `cb?`): `void`
903
903
 
904
- Defined in: [src/http/WebSocket.ts:54](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/WebSocket.ts#L54)
904
+ Defined in: [src/http/WebSocket.ts:54](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/WebSocket.ts#L54)
905
905
 
906
906
  Sends data over the WebSocket connection.
907
907
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Enumeration: ACLAction
8
8
 
9
- Defined in: [src/security/AccessControlList.ts:10](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L10)
9
+ Defined in: [src/security/AccessControlList.ts:10](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L10)
10
10
 
11
11
  Describes the various permission actions that can be performed against an entity.
12
12
 
@@ -20,7 +20,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
20
20
 
21
21
  > **CREATE**: `"CREATE"`
22
22
 
23
- Defined in: [src/security/AccessControlList.ts:11](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L11)
23
+ Defined in: [src/security/AccessControlList.ts:11](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L11)
24
24
 
25
25
  ***
26
26
 
@@ -28,7 +28,7 @@ Defined in: [src/security/AccessControlList.ts:11](https://github.com/rapidrest/
28
28
 
29
29
  > **DELETE**: `"DELETE"`
30
30
 
31
- Defined in: [src/security/AccessControlList.ts:12](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L12)
31
+ Defined in: [src/security/AccessControlList.ts:12](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L12)
32
32
 
33
33
  ***
34
34
 
@@ -36,7 +36,7 @@ Defined in: [src/security/AccessControlList.ts:12](https://github.com/rapidrest/
36
36
 
37
37
  > **FULL**: `"FULL"`
38
38
 
39
- Defined in: [src/security/AccessControlList.ts:13](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L13)
39
+ Defined in: [src/security/AccessControlList.ts:13](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L13)
40
40
 
41
41
  ***
42
42
 
@@ -44,7 +44,7 @@ Defined in: [src/security/AccessControlList.ts:13](https://github.com/rapidrest/
44
44
 
45
45
  > **READ**: `"READ"`
46
46
 
47
- Defined in: [src/security/AccessControlList.ts:14](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L14)
47
+ Defined in: [src/security/AccessControlList.ts:14](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L14)
48
48
 
49
49
  ***
50
50
 
@@ -52,7 +52,7 @@ Defined in: [src/security/AccessControlList.ts:14](https://github.com/rapidrest/
52
52
 
53
53
  > **SPECIAL**: `"SPECIAL"`
54
54
 
55
- Defined in: [src/security/AccessControlList.ts:15](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L15)
55
+ Defined in: [src/security/AccessControlList.ts:15](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L15)
56
56
 
57
57
  ***
58
58
 
@@ -60,4 +60,4 @@ Defined in: [src/security/AccessControlList.ts:15](https://github.com/rapidrest/
60
60
 
61
61
  > **UPDATE**: `"UPDATE"`
62
62
 
63
- Defined in: [src/security/AccessControlList.ts:16](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L16)
63
+ Defined in: [src/security/AccessControlList.ts:16](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L16)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Enumeration: ApiErrorMessages
8
8
 
9
- Defined in: [src/ApiErrors.ts:24](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L24)
9
+ Defined in: [src/ApiErrors.ts:24](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L24)
10
10
 
11
11
  Defines the default message of all common API errors.
12
12
 
@@ -16,7 +16,7 @@ Defines the default message of all common API errors.
16
16
 
17
17
  > **AUTH\_FAILED**: `"Invalid or missing authentication token."`
18
18
 
19
- Defined in: [src/ApiErrors.ts:37](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L37)
19
+ Defined in: [src/ApiErrors.ts:37](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L37)
20
20
 
21
21
  ***
22
22
 
@@ -24,7 +24,7 @@ Defined in: [src/ApiErrors.ts:37](https://github.com/rapidrest/service-core/blob
24
24
 
25
25
  > **AUTH\_PERMISSION\_FAILURE**: `"User does not have permission to perform this action."`
26
26
 
27
- Defined in: [src/ApiErrors.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L38)
27
+ Defined in: [src/ApiErrors.ts:38](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L38)
28
28
 
29
29
  ***
30
30
 
@@ -32,7 +32,7 @@ Defined in: [src/ApiErrors.ts:38](https://github.com/rapidrest/service-core/blob
32
32
 
33
33
  > **AUTH\_REQUIRED**: `"Authorization is required to access this resource."`
34
34
 
35
- Defined in: [src/ApiErrors.ts:36](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L36)
35
+ Defined in: [src/ApiErrors.ts:36](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L36)
36
36
 
37
37
  ***
38
38
 
@@ -40,7 +40,7 @@ Defined in: [src/ApiErrors.ts:36](https://github.com/rapidrest/service-core/blob
40
40
 
41
41
  > **BULK\_CREATE\_FAILURE**: `"Failed to create one or more objects."`
42
42
 
43
- Defined in: [src/ApiErrors.ts:34](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L34)
43
+ Defined in: [src/ApiErrors.ts:34](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L34)
44
44
 
45
45
  ***
46
46
 
@@ -48,7 +48,7 @@ Defined in: [src/ApiErrors.ts:34](https://github.com/rapidrest/service-core/blob
48
48
 
49
49
  > **BULK\_UPDATE\_FAILURE**: `"Failed to update one or more objects."`
50
50
 
51
- Defined in: [src/ApiErrors.ts:35](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L35)
51
+ Defined in: [src/ApiErrors.ts:35](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L35)
52
52
 
53
53
  ***
54
54
 
@@ -56,7 +56,7 @@ Defined in: [src/ApiErrors.ts:35](https://github.com/rapidrest/service-core/blob
56
56
 
57
57
  > **IDENTIFIER\_EXISTS**: `"A resource with that identifier already exists."`
58
58
 
59
- Defined in: [src/ApiErrors.ts:29](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L29)
59
+ Defined in: [src/ApiErrors.ts:29](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L29)
60
60
 
61
61
  ***
62
62
 
@@ -64,7 +64,7 @@ Defined in: [src/ApiErrors.ts:29](https://github.com/rapidrest/service-core/blob
64
64
 
65
65
  > **INTERNAL\_ERROR**: `"An internal error has occurred. Please contact the adminstrator."`
66
66
 
67
- Defined in: [src/ApiErrors.ts:26](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L26)
67
+ Defined in: [src/ApiErrors.ts:26](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L26)
68
68
 
69
69
  ***
70
70
 
@@ -72,7 +72,7 @@ Defined in: [src/ApiErrors.ts:26](https://github.com/rapidrest/service-core/blob
72
72
 
73
73
  > **INVALID\_OBJECT\_VERSION**: `"Invalid object version. Do you have the latest version?"`
74
74
 
75
- Defined in: [src/ApiErrors.ts:30](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L30)
75
+ Defined in: [src/ApiErrors.ts:30](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L30)
76
76
 
77
77
  ***
78
78
 
@@ -80,7 +80,7 @@ Defined in: [src/ApiErrors.ts:30](https://github.com/rapidrest/service-core/blob
80
80
 
81
81
  > **INVALID\_REQUEST**: `"Invalid message or request."`
82
82
 
83
- Defined in: [src/ApiErrors.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L27)
83
+ Defined in: [src/ApiErrors.ts:27](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L27)
84
84
 
85
85
  ***
86
86
 
@@ -88,7 +88,7 @@ Defined in: [src/ApiErrors.ts:27](https://github.com/rapidrest/service-core/blob
88
88
 
89
89
  > **NOT\_FOUND**: `"No resource could be found with the specified identifier."`
90
90
 
91
- Defined in: [src/ApiErrors.ts:28](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L28)
91
+ Defined in: [src/ApiErrors.ts:28](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L28)
92
92
 
93
93
  ***
94
94
 
@@ -96,7 +96,7 @@ Defined in: [src/ApiErrors.ts:28](https://github.com/rapidrest/service-core/blob
96
96
 
97
97
  > **OBJECT\_ID\_MISMATCH**: `"The object provided does not match the identifier given."`
98
98
 
99
- Defined in: [src/ApiErrors.ts:31](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L31)
99
+ Defined in: [src/ApiErrors.ts:31](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L31)
100
100
 
101
101
  ***
102
102
 
@@ -104,7 +104,7 @@ Defined in: [src/ApiErrors.ts:31](https://github.com/rapidrest/service-core/blob
104
104
 
105
105
  > **SEARCH\_INVALID\_ME\_REFERENCE**: `` "Use of the `me` reference requires authentication." ``
106
106
 
107
- Defined in: [src/ApiErrors.ts:33](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L33)
107
+ Defined in: [src/ApiErrors.ts:33](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L33)
108
108
 
109
109
  ***
110
110
 
@@ -112,7 +112,7 @@ Defined in: [src/ApiErrors.ts:33](https://github.com/rapidrest/service-core/blob
112
112
 
113
113
  > **SEARCH\_INVALID\_RANGE**: `"Invalid range value: '{{value}}'. Expected 2 arguments, got {{length}}"`
114
114
 
115
- Defined in: [src/ApiErrors.ts:32](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L32)
115
+ Defined in: [src/ApiErrors.ts:32](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L32)
116
116
 
117
117
  ***
118
118
 
@@ -120,4 +120,4 @@ Defined in: [src/ApiErrors.ts:32](https://github.com/rapidrest/service-core/blob
120
120
 
121
121
  > **UNKNOWN**: `"An unknown error has occurred. Please try again."`
122
122
 
123
- Defined in: [src/ApiErrors.ts:25](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L25)
123
+ Defined in: [src/ApiErrors.ts:25](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L25)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Enumeration: ApiErrors
8
8
 
9
- Defined in: [src/ApiErrors.ts:4](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L4)
9
+ Defined in: [src/ApiErrors.ts:4](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L4)
10
10
 
11
11
  Defines the unique codes for all common API errors.
12
12
 
@@ -16,7 +16,7 @@ Defines the unique codes for all common API errors.
16
16
 
17
17
  > **AUTH\_FAILED**: `"api-101"`
18
18
 
19
- Defined in: [src/ApiErrors.ts:17](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L17)
19
+ Defined in: [src/ApiErrors.ts:17](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L17)
20
20
 
21
21
  ***
22
22
 
@@ -24,7 +24,7 @@ Defined in: [src/ApiErrors.ts:17](https://github.com/rapidrest/service-core/blob
24
24
 
25
25
  > **AUTH\_PERMISSION\_FAILURE**: `"api-102"`
26
26
 
27
- Defined in: [src/ApiErrors.ts:18](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L18)
27
+ Defined in: [src/ApiErrors.ts:18](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L18)
28
28
 
29
29
  ***
30
30
 
@@ -32,7 +32,7 @@ Defined in: [src/ApiErrors.ts:18](https://github.com/rapidrest/service-core/blob
32
32
 
33
33
  > **AUTH\_REQUIRED**: `"api-100"`
34
34
 
35
- Defined in: [src/ApiErrors.ts:16](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L16)
35
+ Defined in: [src/ApiErrors.ts:16](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L16)
36
36
 
37
37
  ***
38
38
 
@@ -40,7 +40,7 @@ Defined in: [src/ApiErrors.ts:16](https://github.com/rapidrest/service-core/blob
40
40
 
41
41
  > **BULK\_CREATE\_FAILURE**: `"api-021"`
42
42
 
43
- Defined in: [src/ApiErrors.ts:14](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L14)
43
+ Defined in: [src/ApiErrors.ts:14](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L14)
44
44
 
45
45
  ***
46
46
 
@@ -48,7 +48,7 @@ Defined in: [src/ApiErrors.ts:14](https://github.com/rapidrest/service-core/blob
48
48
 
49
49
  > **BULK\_UPDATE\_FAILURE**: `"api-022"`
50
50
 
51
- Defined in: [src/ApiErrors.ts:15](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L15)
51
+ Defined in: [src/ApiErrors.ts:15](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L15)
52
52
 
53
53
  ***
54
54
 
@@ -56,7 +56,7 @@ Defined in: [src/ApiErrors.ts:15](https://github.com/rapidrest/service-core/blob
56
56
 
57
57
  > **IDENTIFIER\_EXISTS**: `"api-011"`
58
58
 
59
- Defined in: [src/ApiErrors.ts:9](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L9)
59
+ Defined in: [src/ApiErrors.ts:9](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L9)
60
60
 
61
61
  ***
62
62
 
@@ -64,7 +64,7 @@ Defined in: [src/ApiErrors.ts:9](https://github.com/rapidrest/service-core/blob/
64
64
 
65
65
  > **INTERNAL\_ERROR**: `"api-002"`
66
66
 
67
- Defined in: [src/ApiErrors.ts:6](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L6)
67
+ Defined in: [src/ApiErrors.ts:6](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L6)
68
68
 
69
69
  ***
70
70
 
@@ -72,7 +72,7 @@ Defined in: [src/ApiErrors.ts:6](https://github.com/rapidrest/service-core/blob/
72
72
 
73
73
  > **INVALID\_OBJECT\_VERSION**: `"api-012"`
74
74
 
75
- Defined in: [src/ApiErrors.ts:10](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L10)
75
+ Defined in: [src/ApiErrors.ts:10](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L10)
76
76
 
77
77
  ***
78
78
 
@@ -80,7 +80,7 @@ Defined in: [src/ApiErrors.ts:10](https://github.com/rapidrest/service-core/blob
80
80
 
81
81
  > **INVALID\_REQUEST**: `"api-003"`
82
82
 
83
- Defined in: [src/ApiErrors.ts:7](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L7)
83
+ Defined in: [src/ApiErrors.ts:7](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L7)
84
84
 
85
85
  ***
86
86
 
@@ -88,7 +88,7 @@ Defined in: [src/ApiErrors.ts:7](https://github.com/rapidrest/service-core/blob/
88
88
 
89
89
  > **NOT\_FOUND**: `"api-010"`
90
90
 
91
- Defined in: [src/ApiErrors.ts:8](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L8)
91
+ Defined in: [src/ApiErrors.ts:8](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L8)
92
92
 
93
93
  ***
94
94
 
@@ -96,7 +96,7 @@ Defined in: [src/ApiErrors.ts:8](https://github.com/rapidrest/service-core/blob/
96
96
 
97
97
  > **OBJECT\_ID\_MISMATCH**: `"api-013"`
98
98
 
99
- Defined in: [src/ApiErrors.ts:11](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L11)
99
+ Defined in: [src/ApiErrors.ts:11](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L11)
100
100
 
101
101
  ***
102
102
 
@@ -104,7 +104,7 @@ Defined in: [src/ApiErrors.ts:11](https://github.com/rapidrest/service-core/blob
104
104
 
105
105
  > **SEARCH\_INVALID\_ME\_REFERENCE**: `"api-015"`
106
106
 
107
- Defined in: [src/ApiErrors.ts:13](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L13)
107
+ Defined in: [src/ApiErrors.ts:13](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L13)
108
108
 
109
109
  ***
110
110
 
@@ -112,7 +112,7 @@ Defined in: [src/ApiErrors.ts:13](https://github.com/rapidrest/service-core/blob
112
112
 
113
113
  > **SEARCH\_INVALID\_RANGE**: `"api-014"`
114
114
 
115
- Defined in: [src/ApiErrors.ts:12](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L12)
115
+ Defined in: [src/ApiErrors.ts:12](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L12)
116
116
 
117
117
  ***
118
118
 
@@ -120,4 +120,4 @@ Defined in: [src/ApiErrors.ts:12](https://github.com/rapidrest/service-core/blob
120
120
 
121
121
  > **UNKNOWN**: `"api-001"`
122
122
 
123
- Defined in: [src/ApiErrors.ts:5](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/ApiErrors.ts#L5)
123
+ Defined in: [src/ApiErrors.ts:5](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/ApiErrors.ts#L5)
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **createWebSocketStream**(`shim`): `Duplex`
10
10
 
11
- Defined in: [src/http/WebSocket.ts:85](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/WebSocket.ts#L85)
11
+ Defined in: [src/http/WebSocket.ts:85](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/WebSocket.ts#L85)
12
12
 
13
13
  Creates a Node.js `Duplex` stream from a `UWSWebSocketShim`, compatible with the
14
14
  `createWebSocketStream` API from the `ws` library.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isSqlDataSource**(`conn`): `boolean`
10
10
 
11
- Defined in: [src/database/ConnectionKinds.ts:12](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/ConnectionKinds.ts#L12)
11
+ Defined in: [src/database/ConnectionKinds.ts:12](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/database/ConnectionKinds.ts#L12)
12
12
 
13
13
  Determines whether the given connection object is a TypeORM `DataSource` for a SQL database. This check is
14
14
  performed without importing the optional `typeorm` package by duck-typing the connection object.
@@ -8,10 +8,10 @@
8
8
 
9
9
  > **readBody**(`uwsRes`, `req`): `Promise`\<`void`\>
10
10
 
11
- Defined in: [src/http/Adapters.ts:224](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Adapters.ts#L224)
11
+ Defined in: [src/http/Adapters.ts:224](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Adapters.ts#L224)
12
12
 
13
- Reads the full request body from a uWS response object as a Buffer.
14
- Body parsing (JSON / URL-encoded) is applied based on content-type and the result
13
+ Reads the full request body from a uWS response object as a Buffer.
14
+ Body parsing (JSON / URL-encoded) is applied based on content-type and the result
15
15
  is cached on `req.body` / `req.rawBody`.
16
16
 
17
17
  ## Parameters
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **resolveCollectionName**(`clazz`): `string`
10
10
 
11
- Defined in: [src/database/NamingUtils.ts:38](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/NamingUtils.ts#L38)
11
+ Defined in: [src/database/NamingUtils.ts:38](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/database/NamingUtils.ts#L38)
12
12
 
13
13
  Resolves the name of the database collection (or table) that records of the given model class are stored in.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **runChain**(`handlers`, `req`, `res`): `Promise`\<`void`\>
10
10
 
11
- Defined in: [src/http/Router.ts:43](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L43)
11
+ Defined in: [src/http/Router.ts:43](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L43)
12
12
 
13
13
  Runs an ordered array of middleware handlers sequentially, Express-style.
14
14
  Supports both 3-param `(req, res, next)` handlers and 4-param `(err, req, res, next)`
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **snakeCase**(`str`): `string`
10
10
 
11
- Defined in: [src/database/NamingUtils.ts:14](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/NamingUtils.ts#L14)
11
+ Defined in: [src/database/NamingUtils.ts:14](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/database/NamingUtils.ts#L14)
12
12
 
13
13
  Converts a string into snake_case.
14
14
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ACLRecord
8
8
 
9
- Defined in: [src/security/AccessControlList.ts:33](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L33)
9
+ Defined in: [src/security/AccessControlList.ts:33](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L33)
10
10
 
11
11
  The `ACLRecord` interface describes a single permissions entry in an `AccessControlList` that grants or denies
12
12
  a set of permissions to a single user or role.
@@ -29,7 +29,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
29
29
 
30
30
  > **create**: `boolean` \| `null`
31
31
 
32
- Defined in: [src/security/AccessControlList.ts:42](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L42)
32
+ Defined in: [src/security/AccessControlList.ts:42](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L42)
33
33
 
34
34
  Indicates that the user or role has permission to create new records of the entity.
35
35
 
@@ -39,7 +39,7 @@ Indicates that the user or role has permission to create new records of the enti
39
39
 
40
40
  > **delete**: `boolean` \| `null`
41
41
 
42
- Defined in: [src/security/AccessControlList.ts:57](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L57)
42
+ Defined in: [src/security/AccessControlList.ts:57](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L57)
43
43
 
44
44
  Indicates that the user or role has permission to delete existing records of the entity.
45
45
 
@@ -49,7 +49,7 @@ Indicates that the user or role has permission to delete existing records of the
49
49
 
50
50
  > **full**: `boolean` \| `null`
51
51
 
52
- Defined in: [src/security/AccessControlList.ts:69](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L69)
52
+ Defined in: [src/security/AccessControlList.ts:69](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L69)
53
53
 
54
54
  Indicates that the user or role has total control over records of the entity. This supersedes all of the above
55
55
  permissions.
@@ -60,7 +60,7 @@ permissions.
60
60
 
61
61
  > **read**: `boolean` \| `null`
62
62
 
63
- Defined in: [src/security/AccessControlList.ts:47](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L47)
63
+ Defined in: [src/security/AccessControlList.ts:47](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L47)
64
64
 
65
65
  Indicates that the user or role has permission to read records of the entity.
66
66
 
@@ -70,7 +70,7 @@ Indicates that the user or role has permission to read records of the entity.
70
70
 
71
71
  > **special**: `boolean` \| `null`
72
72
 
73
- Defined in: [src/security/AccessControlList.ts:63](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L63)
73
+ Defined in: [src/security/AccessControlList.ts:63](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L63)
74
74
 
75
75
  Indicates that the user or role has special permission over records of the entity. The exact meaning of this
76
76
  may vary by service.
@@ -81,7 +81,7 @@ may vary by service.
81
81
 
82
82
  > **update**: `boolean` \| `null`
83
83
 
84
- Defined in: [src/security/AccessControlList.ts:52](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L52)
84
+ Defined in: [src/security/AccessControlList.ts:52](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L52)
85
85
 
86
86
  Indicates that the user or role has permission to modify existing records of the entity.
87
87
 
@@ -91,6 +91,6 @@ Indicates that the user or role has permission to modify existing records of the
91
91
 
92
92
  > **userOrRoleId**: `string`
93
93
 
94
- Defined in: [src/security/AccessControlList.ts:37](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/security/AccessControlList.ts#L37)
94
+ Defined in: [src/security/AccessControlList.ts:37](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/security/AccessControlList.ts#L37)
95
95
 
96
96
  The unique identifier of the user or role that the record belongs to.