@rapidrest/service-core 1.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (332) hide show
  1. package/LICENSE +23 -0
  2. package/README.md +16 -0
  3. package/dist/lib/ApiErrors.js +41 -0
  4. package/dist/lib/ApiErrors.js.map +1 -0
  5. package/dist/lib/BackgroundService.js +16 -0
  6. package/dist/lib/BackgroundService.js.map +1 -0
  7. package/dist/lib/BackgroundServiceManager.js +135 -0
  8. package/dist/lib/BackgroundServiceManager.js.map +1 -0
  9. package/dist/lib/BulkError.js +24 -0
  10. package/dist/lib/BulkError.js.map +1 -0
  11. package/dist/lib/EventListenerManager.js +161 -0
  12. package/dist/lib/EventListenerManager.js.map +1 -0
  13. package/dist/lib/NetUtils.js +103 -0
  14. package/dist/lib/NetUtils.js.map +1 -0
  15. package/dist/lib/NotificationUtils.js +34 -0
  16. package/dist/lib/NotificationUtils.js.map +1 -0
  17. package/dist/lib/ObjectFactory.js +90 -0
  18. package/dist/lib/ObjectFactory.js.map +1 -0
  19. package/dist/lib/OpenApiSpec.js +748 -0
  20. package/dist/lib/OpenApiSpec.js.map +1 -0
  21. package/dist/lib/Server.js +549 -0
  22. package/dist/lib/Server.js.map +1 -0
  23. package/dist/lib/Types.js +2 -0
  24. package/dist/lib/Types.js.map +1 -0
  25. package/dist/lib/auth/AuthMiddleware.js +229 -0
  26. package/dist/lib/auth/AuthMiddleware.js.map +1 -0
  27. package/dist/lib/auth/AuthStrategy.js +2 -0
  28. package/dist/lib/auth/AuthStrategy.js.map +1 -0
  29. package/dist/lib/auth/BasicStrategy.js +106 -0
  30. package/dist/lib/auth/BasicStrategy.js.map +1 -0
  31. package/dist/lib/auth/JWTStrategy.js +161 -0
  32. package/dist/lib/auth/JWTStrategy.js.map +1 -0
  33. package/dist/lib/auth/index.js +5 -0
  34. package/dist/lib/auth/index.js.map +1 -0
  35. package/dist/lib/database/ConnectionKinds.js +14 -0
  36. package/dist/lib/database/ConnectionKinds.js.map +1 -0
  37. package/dist/lib/database/ConnectionManager.js +161 -0
  38. package/dist/lib/database/ConnectionManager.js.map +1 -0
  39. package/dist/lib/database/MongoConnection.js +86 -0
  40. package/dist/lib/database/MongoConnection.js.map +1 -0
  41. package/dist/lib/database/MongoRepository.js +136 -0
  42. package/dist/lib/database/MongoRepository.js.map +1 -0
  43. package/dist/lib/database/MongoSchemaSync.js +136 -0
  44. package/dist/lib/database/MongoSchemaSync.js.map +1 -0
  45. package/dist/lib/database/NamingUtils.js +52 -0
  46. package/dist/lib/database/NamingUtils.js.map +1 -0
  47. package/dist/lib/database/TypeOrmSupport.js +146 -0
  48. package/dist/lib/database/TypeOrmSupport.js.map +1 -0
  49. package/dist/lib/database/index.js +7 -0
  50. package/dist/lib/database/index.js.map +1 -0
  51. package/dist/lib/decorators/DatabaseDecorators.js +52 -0
  52. package/dist/lib/decorators/DatabaseDecorators.js.map +1 -0
  53. package/dist/lib/decorators/DocDecorators.js +120 -0
  54. package/dist/lib/decorators/DocDecorators.js.map +1 -0
  55. package/dist/lib/decorators/EventDecorators.js +24 -0
  56. package/dist/lib/decorators/EventDecorators.js.map +1 -0
  57. package/dist/lib/decorators/ModelDecorators.js +173 -0
  58. package/dist/lib/decorators/ModelDecorators.js.map +1 -0
  59. package/dist/lib/decorators/PersistenceDecorators.js +177 -0
  60. package/dist/lib/decorators/PersistenceDecorators.js.map +1 -0
  61. package/dist/lib/decorators/RouteDecorators.js +324 -0
  62. package/dist/lib/decorators/RouteDecorators.js.map +1 -0
  63. package/dist/lib/decorators/index.js +7 -0
  64. package/dist/lib/decorators/index.js.map +1 -0
  65. package/dist/lib/http/Adapters.js +230 -0
  66. package/dist/lib/http/Adapters.js.map +1 -0
  67. package/dist/lib/http/Router.js +403 -0
  68. package/dist/lib/http/Router.js.map +1 -0
  69. package/dist/lib/http/WebSocket.js +82 -0
  70. package/dist/lib/http/WebSocket.js.map +1 -0
  71. package/dist/lib/http/index.js +4 -0
  72. package/dist/lib/http/index.js.map +1 -0
  73. package/dist/lib/http/types.js +5 -0
  74. package/dist/lib/http/types.js.map +1 -0
  75. package/dist/lib/index.js +18 -0
  76. package/dist/lib/index.js.map +1 -0
  77. package/dist/lib/models/BaseEntity.js +83 -0
  78. package/dist/lib/models/BaseEntity.js.map +1 -0
  79. package/dist/lib/models/BaseMongoEntity.js +40 -0
  80. package/dist/lib/models/BaseMongoEntity.js.map +1 -0
  81. package/dist/lib/models/ModelUtils.js +645 -0
  82. package/dist/lib/models/ModelUtils.js.map +1 -0
  83. package/dist/lib/models/RecoverableBaseEntity.js +39 -0
  84. package/dist/lib/models/RecoverableBaseEntity.js.map +1 -0
  85. package/dist/lib/models/RecoverableBaseMongoEntity.js +40 -0
  86. package/dist/lib/models/RecoverableBaseMongoEntity.js.map +1 -0
  87. package/dist/lib/models/RepoUtils.js +717 -0
  88. package/dist/lib/models/RepoUtils.js.map +1 -0
  89. package/dist/lib/models/SimpleEntity.js +42 -0
  90. package/dist/lib/models/SimpleEntity.js.map +1 -0
  91. package/dist/lib/models/SimpleMongoEntity.js +38 -0
  92. package/dist/lib/models/SimpleMongoEntity.js.map +1 -0
  93. package/dist/lib/models/StatusExtraData.js +15 -0
  94. package/dist/lib/models/StatusExtraData.js.map +1 -0
  95. package/dist/lib/models/index.js +10 -0
  96. package/dist/lib/models/index.js.map +1 -0
  97. package/dist/lib/routes/AdminRoute.js +268 -0
  98. package/dist/lib/routes/AdminRoute.js.map +1 -0
  99. package/dist/lib/routes/MetricsRoute.js +86 -0
  100. package/dist/lib/routes/MetricsRoute.js.map +1 -0
  101. package/dist/lib/routes/ModelRoute.js +481 -0
  102. package/dist/lib/routes/ModelRoute.js.map +1 -0
  103. package/dist/lib/routes/OpenAPIRoute.js +115 -0
  104. package/dist/lib/routes/OpenAPIRoute.js.map +1 -0
  105. package/dist/lib/routes/RouteUtils.js +445 -0
  106. package/dist/lib/routes/RouteUtils.js.map +1 -0
  107. package/dist/lib/routes/StatusRoute.js +55 -0
  108. package/dist/lib/routes/StatusRoute.js.map +1 -0
  109. package/dist/lib/routes/index.js +7 -0
  110. package/dist/lib/routes/index.js.map +1 -0
  111. package/dist/lib/security/ACLRouteMongo.js +194 -0
  112. package/dist/lib/security/ACLRouteMongo.js.map +1 -0
  113. package/dist/lib/security/ACLRouteSQL.js +193 -0
  114. package/dist/lib/security/ACLRouteSQL.js.map +1 -0
  115. package/dist/lib/security/ACLUtils.js +457 -0
  116. package/dist/lib/security/ACLUtils.js.map +1 -0
  117. package/dist/lib/security/AccessControlList.js +18 -0
  118. package/dist/lib/security/AccessControlList.js.map +1 -0
  119. package/dist/lib/security/AccessControlListMongo.js +155 -0
  120. package/dist/lib/security/AccessControlListMongo.js.map +1 -0
  121. package/dist/lib/security/AccessControlListSQL.js +149 -0
  122. package/dist/lib/security/AccessControlListSQL.js.map +1 -0
  123. package/dist/lib/security/index.js +3 -0
  124. package/dist/lib/security/index.js.map +1 -0
  125. package/dist/lib/test/index.js +3 -0
  126. package/dist/lib/test/index.js.map +1 -0
  127. package/dist/lib/test/request.js +99 -0
  128. package/dist/lib/test/request.js.map +1 -0
  129. package/dist/lib/test/requestws.js +173 -0
  130. package/dist/lib/test/requestws.js.map +1 -0
  131. package/dist/types/ApiErrors.d.ts +38 -0
  132. package/dist/types/BackgroundService.d.ts +30 -0
  133. package/dist/types/BackgroundServiceManager.d.ts +66 -0
  134. package/dist/types/BulkError.d.ts +11 -0
  135. package/dist/types/EventListenerManager.d.ts +36 -0
  136. package/dist/types/NetUtils.d.ts +29 -0
  137. package/dist/types/NotificationUtils.d.ts +25 -0
  138. package/dist/types/ObjectFactory.d.ts +17 -0
  139. package/dist/types/OpenApiSpec.d.ts +114 -0
  140. package/dist/types/Server.d.ts +180 -0
  141. package/dist/types/Types.d.ts +8 -0
  142. package/dist/types/auth/AuthMiddleware.d.ts +42 -0
  143. package/dist/types/auth/AuthStrategy.d.ts +32 -0
  144. package/dist/types/auth/BasicStrategy.d.ts +33 -0
  145. package/dist/types/auth/JWTStrategy.d.ts +61 -0
  146. package/dist/types/auth/index.d.ts +4 -0
  147. package/dist/types/database/ConnectionKinds.d.ts +7 -0
  148. package/dist/types/database/ConnectionManager.d.ts +35 -0
  149. package/dist/types/database/MongoConnection.d.ts +54 -0
  150. package/dist/types/database/MongoRepository.d.ts +92 -0
  151. package/dist/types/database/MongoSchemaSync.d.ts +41 -0
  152. package/dist/types/database/NamingUtils.d.ts +24 -0
  153. package/dist/types/database/TypeOrmSupport.d.ts +20 -0
  154. package/dist/types/database/index.d.ts +6 -0
  155. package/dist/types/decorators/DatabaseDecorators.d.ts +18 -0
  156. package/dist/types/decorators/DocDecorators.d.ts +69 -0
  157. package/dist/types/decorators/EventDecorators.d.ts +12 -0
  158. package/dist/types/decorators/ModelDecorators.d.ts +80 -0
  159. package/dist/types/decorators/PersistenceDecorators.d.ts +117 -0
  160. package/dist/types/decorators/RouteDecorators.d.ts +172 -0
  161. package/dist/types/decorators/index.d.ts +6 -0
  162. package/dist/types/http/Adapters.d.ts +68 -0
  163. package/dist/types/http/Router.d.ts +99 -0
  164. package/dist/types/http/WebSocket.d.ts +56 -0
  165. package/dist/types/http/index.d.ts +6 -0
  166. package/dist/types/http/types.d.ts +54 -0
  167. package/dist/types/index.d.ts +17 -0
  168. package/dist/types/models/BaseEntity.d.ts +29 -0
  169. package/dist/types/models/BaseMongoEntity.d.ts +13 -0
  170. package/dist/types/models/ModelUtils.d.ts +166 -0
  171. package/dist/types/models/RecoverableBaseEntity.d.ts +16 -0
  172. package/dist/types/models/RecoverableBaseMongoEntity.d.ts +16 -0
  173. package/dist/types/models/RepoUtils.d.ts +154 -0
  174. package/dist/types/models/SimpleEntity.d.ts +14 -0
  175. package/dist/types/models/SimpleMongoEntity.d.ts +15 -0
  176. package/dist/types/models/StatusExtraData.d.ts +6 -0
  177. package/dist/types/models/index.d.ts +9 -0
  178. package/dist/types/routes/AdminRoute.d.ts +47 -0
  179. package/dist/types/routes/MetricsRoute.d.ts +15 -0
  180. package/dist/types/routes/ModelRoute.d.ts +226 -0
  181. package/dist/types/routes/OpenAPIRoute.d.ts +17 -0
  182. package/dist/types/routes/RouteUtils.d.ts +55 -0
  183. package/dist/types/routes/StatusRoute.d.ts +11 -0
  184. package/dist/types/routes/index.d.ts +6 -0
  185. package/dist/types/security/ACLRouteMongo.d.ts +19 -0
  186. package/dist/types/security/ACLRouteSQL.d.ts +19 -0
  187. package/dist/types/security/ACLUtils.d.ts +94 -0
  188. package/dist/types/security/AccessControlList.d.ts +103 -0
  189. package/dist/types/security/AccessControlListMongo.d.ts +24 -0
  190. package/dist/types/security/AccessControlListSQL.d.ts +24 -0
  191. package/dist/types/security/index.d.ts +2 -0
  192. package/dist/types/test/index.d.ts +2 -0
  193. package/dist/types/test/request.d.ts +24 -0
  194. package/dist/types/test/requestws.d.ts +21 -0
  195. package/docs/Makefile +20 -0
  196. package/docs/conf.py +58 -0
  197. package/docs/index.rst +17 -0
  198. package/docs/make.bat +35 -0
  199. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/README.md +13 -0
  200. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md +25 -0
  201. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md +25 -0
  202. package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md +25 -0
  203. package/docs/reference/@rapidrest/namespaces/DocDecorators/README.md +23 -0
  204. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md +25 -0
  205. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md +25 -0
  206. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md +25 -0
  207. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md +25 -0
  208. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md +25 -0
  209. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md +28 -0
  210. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md +25 -0
  211. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md +25 -0
  212. package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/TypeInfo.md +28 -0
  213. package/docs/reference/@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md +57 -0
  214. package/docs/reference/@rapidrest/namespaces/EventDecorators/README.md +12 -0
  215. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/EventListener.md +17 -0
  216. package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/OnEvent.md +26 -0
  217. package/docs/reference/@rapidrest/namespaces/ModelDecorators/README.md +26 -0
  218. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Cache.md +25 -0
  219. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/ChildEntity.md +18 -0
  220. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/DataStore.md +25 -0
  221. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Identifier.md +27 -0
  222. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Protect.md +35 -0
  223. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Reference.md +25 -0
  224. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Shard.md +27 -0
  225. package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/TrackChanges.md +26 -0
  226. package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md +45 -0
  227. package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md +14 -0
  228. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/README.md +25 -0
  229. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md +25 -0
  230. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md +26 -0
  231. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md +119 -0
  232. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md +25 -0
  233. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Unique.md +68 -0
  234. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getColumnMetadata.md +26 -0
  235. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getEntityName.md +26 -0
  236. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getIndexMetadata.md +27 -0
  237. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md +41 -0
  238. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md +51 -0
  239. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md +41 -0
  240. package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md +51 -0
  241. package/docs/reference/@rapidrest/namespaces/RouteDecorators/README.md +36 -0
  242. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/After.md +26 -0
  243. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Auth.md +33 -0
  244. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/AuthResult.md +31 -0
  245. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Before.md +25 -0
  246. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/ContentType.md +25 -0
  247. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Delete.md +25 -0
  248. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md +25 -0
  249. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md +25 -0
  250. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md +25 -0
  251. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md +31 -0
  252. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md +25 -0
  253. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md +25 -0
  254. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md +26 -0
  255. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md +25 -0
  256. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md +25 -0
  257. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md +31 -0
  258. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md +25 -0
  259. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md +26 -0
  260. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md +31 -0
  261. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md +26 -0
  262. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md +31 -0
  263. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md +25 -0
  264. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md +33 -0
  265. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md +31 -0
  266. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md +25 -0
  267. package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md +25 -0
  268. package/docs/reference/README.md +20 -0
  269. package/docs/reference/classes/ACLUtils.md +251 -0
  270. package/docs/reference/classes/AdminRoute.md +51 -0
  271. package/docs/reference/classes/AuthMiddleware.md +131 -0
  272. package/docs/reference/classes/BackgroundService.md +117 -0
  273. package/docs/reference/classes/BackgroundServiceManager.md +172 -0
  274. package/docs/reference/classes/BaseEntity.md +82 -0
  275. package/docs/reference/classes/BaseMongoEntity.md +107 -0
  276. package/docs/reference/classes/BasicStrategy.md +89 -0
  277. package/docs/reference/classes/BasicStrategyOptions.md +91 -0
  278. package/docs/reference/classes/BulkError.md +271 -0
  279. package/docs/reference/classes/ConnectionManager.md +75 -0
  280. package/docs/reference/classes/EventListenerManager.md +88 -0
  281. package/docs/reference/classes/JWTStrategy.md +77 -0
  282. package/docs/reference/classes/JWTStrategyOptions.md +97 -0
  283. package/docs/reference/classes/MetricsRoute.md +27 -0
  284. package/docs/reference/classes/ModelRoute.md +527 -0
  285. package/docs/reference/classes/ModelUtils.md +448 -0
  286. package/docs/reference/classes/MongoConnection.md +218 -0
  287. package/docs/reference/classes/MongoRepository.md +354 -0
  288. package/docs/reference/classes/MongoSchemaSync.md +67 -0
  289. package/docs/reference/classes/NetUtils.md +90 -0
  290. package/docs/reference/classes/NotificationUtils.md +77 -0
  291. package/docs/reference/classes/ObjectFactory.md +336 -0
  292. package/docs/reference/classes/OpenAPIRoute.md +77 -0
  293. package/docs/reference/classes/OpenApiSpec.md +892 -0
  294. package/docs/reference/classes/RecoverableBaseEntity.md +114 -0
  295. package/docs/reference/classes/RecoverableBaseMongoEntity.md +124 -0
  296. package/docs/reference/classes/RedisTransport.md +2202 -0
  297. package/docs/reference/classes/RepoUtils.md +486 -0
  298. package/docs/reference/classes/RouteUtils.md +191 -0
  299. package/docs/reference/classes/Server.md +408 -0
  300. package/docs/reference/classes/SimpleEntity.md +48 -0
  301. package/docs/reference/classes/SimpleMongoEntity.md +66 -0
  302. package/docs/reference/classes/StatusExtraData.md +57 -0
  303. package/docs/reference/classes/StatusRoute.md +26 -0
  304. package/docs/reference/enumerations/ACLAction.md +63 -0
  305. package/docs/reference/enumerations/ApiErrorMessages.md +123 -0
  306. package/docs/reference/enumerations/ApiErrors.md +123 -0
  307. package/docs/reference/functions/isSqlDataSource.md +26 -0
  308. package/docs/reference/functions/resolveCollectionName.md +33 -0
  309. package/docs/reference/functions/snakeCase.md +28 -0
  310. package/docs/reference/globals.md +91 -0
  311. package/docs/reference/interfaces/ACLRecord.md +96 -0
  312. package/docs/reference/interfaces/AccessControlList.md +76 -0
  313. package/docs/reference/interfaces/AuthResult.md +55 -0
  314. package/docs/reference/interfaces/AuthStrategy.md +57 -0
  315. package/docs/reference/interfaces/CreateRequestOptions.md +121 -0
  316. package/docs/reference/interfaces/DeleteRequestOptions.md +147 -0
  317. package/docs/reference/interfaces/FindRequestOptions.md +133 -0
  318. package/docs/reference/interfaces/JWTAuthResult.md +84 -0
  319. package/docs/reference/interfaces/RepoCreateOptions.md +95 -0
  320. package/docs/reference/interfaces/RepoDeleteOptions.md +115 -0
  321. package/docs/reference/interfaces/RepoFindOptions.md +135 -0
  322. package/docs/reference/interfaces/RepoOperationOptions.md +69 -0
  323. package/docs/reference/interfaces/RepoUpdateOptions.md +111 -0
  324. package/docs/reference/interfaces/RequestOptions.md +112 -0
  325. package/docs/reference/interfaces/TruncateRequestOptions.md +175 -0
  326. package/docs/reference/interfaces/UpdateRequestOptions.md +149 -0
  327. package/docs/reference/type-aliases/OneOrMany.md +19 -0
  328. package/docs/reference/type-aliases/OneOrNull.md +19 -0
  329. package/docs/reference/type-aliases/PartialBaseEntity.md +17 -0
  330. package/docs/reference/type-aliases/PartialSimpleEntity.md +17 -0
  331. package/docs/reference/type-aliases/UpdateObject.md +19 -0
  332. package/package.json +125 -0
@@ -0,0 +1,51 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / ColumnOptions
6
+
7
+ # Interface: ColumnOptions
8
+
9
+ Defined in: [src/decorators/PersistenceDecorators.ts:10](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L10)
10
+
11
+ The set of options available when declaring a persisted column/property via the `@Column` decorator.
12
+
13
+ ## Properties
14
+
15
+ ### isObjectId?
16
+
17
+ > `optional` **isObjectId?**: `boolean`
18
+
19
+ Defined in: [src/decorators/PersistenceDecorators.ts:18](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L18)
20
+
21
+ Set to `true` if the column stores a MongoDB `ObjectId` value.
22
+
23
+ ***
24
+
25
+ ### name?
26
+
27
+ > `optional` **name?**: `string`
28
+
29
+ Defined in: [src/decorators/PersistenceDecorators.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L12)
30
+
31
+ The name of the column in the datastore. Defaults to the property name.
32
+
33
+ ***
34
+
35
+ ### nullable?
36
+
37
+ > `optional` **nullable?**: `boolean`
38
+
39
+ Defined in: [src/decorators/PersistenceDecorators.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L14)
40
+
41
+ Set to `true` if the column may store `null`/`undefined` values.
42
+
43
+ ***
44
+
45
+ ### primary?
46
+
47
+ > `optional` **primary?**: `boolean`
48
+
49
+ Defined in: [src/decorators/PersistenceDecorators.ts:16](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L16)
50
+
51
+ Set to `true` if the column is a primary key.
@@ -0,0 +1,41 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / IndexInfo
6
+
7
+ # Interface: IndexInfo
8
+
9
+ Defined in: [src/decorators/PersistenceDecorators.ts:50](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L50)
10
+
11
+ Describes a single database index of a model class.
12
+
13
+ ## Properties
14
+
15
+ ### columns
16
+
17
+ > **columns**: `string`[]
18
+
19
+ Defined in: [src/decorators/PersistenceDecorators.ts:54](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L54)
20
+
21
+ The list of class properties that make up the index.
22
+
23
+ ***
24
+
25
+ ### name?
26
+
27
+ > `optional` **name?**: `string`
28
+
29
+ Defined in: [src/decorators/PersistenceDecorators.ts:52](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L52)
30
+
31
+ The explicit name of the index, if any.
32
+
33
+ ***
34
+
35
+ ### options
36
+
37
+ > **options**: [`IndexOptions`](IndexOptions.md)
38
+
39
+ Defined in: [src/decorators/PersistenceDecorators.ts:56](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L56)
40
+
41
+ The options that the index was declared with.
@@ -0,0 +1,51 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / IndexOptions
6
+
7
+ # Interface: IndexOptions
8
+
9
+ Defined in: [src/decorators/PersistenceDecorators.ts:24](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L24)
10
+
11
+ The set of options available when declaring a database index via the `@Index` decorator.
12
+
13
+ ## Properties
14
+
15
+ ### background?
16
+
17
+ > `optional` **background?**: `boolean`
18
+
19
+ Defined in: [src/decorators/PersistenceDecorators.ts:30](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L30)
20
+
21
+ Set to `true` to build the index in the background. (MongoDB only)
22
+
23
+ ***
24
+
25
+ ### expireAfterSeconds?
26
+
27
+ > `optional` **expireAfterSeconds?**: `number`
28
+
29
+ Defined in: [src/decorators/PersistenceDecorators.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L32)
30
+
31
+ The time, in seconds, after which indexed documents will be automatically deleted. (MongoDB only)
32
+
33
+ ***
34
+
35
+ ### sparse?
36
+
37
+ > `optional` **sparse?**: `boolean`
38
+
39
+ Defined in: [src/decorators/PersistenceDecorators.ts:28](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L28)
40
+
41
+ Set to `true` to only index documents in which the indexed properties exist. (MongoDB only)
42
+
43
+ ***
44
+
45
+ ### unique?
46
+
47
+ > `optional` **unique?**: `boolean`
48
+
49
+ Defined in: [src/decorators/PersistenceDecorators.ts:26](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L26)
50
+
51
+ Set to `true` to enforce that all values of the indexed properties are unique.
@@ -0,0 +1,36 @@
1
+ [**@rapidrest/service-core**](../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../globals.md) / RouteDecorators
6
+
7
+ # RouteDecorators
8
+
9
+ ## Functions
10
+
11
+ - [After](functions/After.md)
12
+ - [Auth](functions/Auth.md)
13
+ - [AuthResult](functions/AuthResult.md)
14
+ - [Before](functions/Before.md)
15
+ - [ContentType](functions/ContentType.md)
16
+ - [Delete](functions/Delete.md)
17
+ - [Get](functions/Get.md)
18
+ - [Head](functions/Head.md)
19
+ - [Header](functions/Header.md)
20
+ - [Method](functions/Method.md)
21
+ - [Model](functions/Model.md)
22
+ - [Options](functions/Options.md)
23
+ - [Param](functions/Param.md)
24
+ - [Patch](functions/Patch.md)
25
+ - [Post](functions/Post.md)
26
+ - [Protect](functions/Protect.md)
27
+ - [Put](functions/Put.md)
28
+ - [Query](functions/Query.md)
29
+ - [Request](functions/Request.md)
30
+ - [RequiresRole](functions/RequiresRole.md)
31
+ - [Response](functions/Response.md)
32
+ - [Route](functions/Route.md)
33
+ - [Socket](functions/Socket.md)
34
+ - [User](functions/User.md)
35
+ - [Validate](functions/Validate.md)
36
+ - [WebSocket](functions/WebSocket.md)
@@ -0,0 +1,26 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / After
6
+
7
+ # Function: After()
8
+
9
+ > **After**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:13](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L13)
12
+
13
+ Indicates a provided function or list of functions to execute *after* the decorated function and before the response
14
+ is sent to a client. Note that the function must call `next()` in order for this decorator to work.
15
+
16
+ ## Parameters
17
+
18
+ ### func
19
+
20
+ `string` \| `Function` \| (`string` \| `Function`)[]
21
+
22
+ The function or list of functions to execute *after* the decorated function.
23
+
24
+ ## Returns
25
+
26
+ (`target`, `propertyKey`, `descriptor`) => `void`
@@ -0,0 +1,33 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Auth
6
+
7
+ # Function: Auth()
8
+
9
+ > **Auth**(`strategies`, `require?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:33](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L33)
12
+
13
+ Applies PassportJS authentication to the decorated route or method for the provided strategy or list of strategies
14
+ should be attempted before processing the route.
15
+
16
+ ## Parameters
17
+
18
+ ### strategies
19
+
20
+ `string` \| `string`[]
21
+
22
+ The PassportJS strategies that will be applied when incoming requests are processed.
23
+
24
+ ### require?
25
+
26
+ `boolean` = `true`
27
+
28
+ Set to `true` to indicate that at least one of the specified authentication strategies must pass to
29
+ proceed, otherwise set to `false`. Default is `true`.
30
+
31
+ ## Returns
32
+
33
+ (`target`, `propertyKey`, `descriptor`) => `void`
@@ -0,0 +1,31 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / AuthResult
6
+
7
+ # Function: AuthResult()
8
+
9
+ > **AuthResult**(`target`, `propertyKey`, `index`): `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:45](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L45)
12
+
13
+ Injects the authenticated authentication result as the value of the decorated argument.
14
+
15
+ ## Parameters
16
+
17
+ ### target
18
+
19
+ `any`
20
+
21
+ ### propertyKey
22
+
23
+ `string`
24
+
25
+ ### index
26
+
27
+ `number`
28
+
29
+ ## Returns
30
+
31
+ `void`
@@ -0,0 +1,25 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Before
6
+
7
+ # Function: Before()
8
+
9
+ > **Before**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:56](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L56)
12
+
13
+ Indicates a provided function or list of functions to execute *before* the decorated function.
14
+
15
+ ## Parameters
16
+
17
+ ### func
18
+
19
+ `string` \| `Function` \| (`string` \| `Function`)[]
20
+
21
+ The function or list of functions to execute *before* the decorated function.
22
+
23
+ ## Returns
24
+
25
+ (`target`, `propertyKey`, `descriptor`) => `void`
@@ -0,0 +1,25 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / ContentType
6
+
7
+ # Function: ContentType()
8
+
9
+ > **ContentType**(`type`): (`target`, `propertyKey`, `descriptor`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:73](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L73)
12
+
13
+ Indicates that the decorated function will return content encoded with the specified content type.
14
+
15
+ ## Parameters
16
+
17
+ ### type
18
+
19
+ `string`
20
+
21
+ The content type that the function will return.
22
+
23
+ ## Returns
24
+
25
+ (`target`, `propertyKey`, `descriptor`) => `void`
@@ -0,0 +1,25 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Delete
6
+
7
+ # Function: Delete()
8
+
9
+ > **Delete**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:86](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L86)
12
+
13
+ Indicates that the decorated function handles incoming `DELETE` requests at the given sub-path.
14
+
15
+ ## Parameters
16
+
17
+ ### path?
18
+
19
+ `string`
20
+
21
+ The sub-path that the route will handle requests for.
22
+
23
+ ## Returns
24
+
25
+ (`target`, `propertyKey`, `descriptor`) => `void`
@@ -0,0 +1,25 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Get
6
+
7
+ # Function: Get()
8
+
9
+ > **Get**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:95](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L95)
12
+
13
+ Indicates that the decorated function handles incoming `GET` requests at the given sub-path.
14
+
15
+ ## Parameters
16
+
17
+ ### path?
18
+
19
+ `string`
20
+
21
+ The sub-path that the route will handle requests for.
22
+
23
+ ## Returns
24
+
25
+ (`target`, `propertyKey`, `descriptor`) => `void`
@@ -0,0 +1,25 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Head
6
+
7
+ # Function: Head()
8
+
9
+ > **Head**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:104](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L104)
12
+
13
+ Indicates that the decorated function handles incoming `HEAD` requests at the given sub-path.
14
+
15
+ ## Parameters
16
+
17
+ ### path?
18
+
19
+ `string`
20
+
21
+ The sub-path that the route will handle requests for.
22
+
23
+ ## Returns
24
+
25
+ (`target`, `propertyKey`, `descriptor`) => `void`
@@ -0,0 +1,25 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Header
6
+
7
+ # Function: Header()
8
+
9
+ > **Header**(`name`): (`target`, `propertyKey`, `index`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:113](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L113)
12
+
13
+ Injects the value of the specified request header with the given name as the value of the decorated argument.
14
+
15
+ ## Parameters
16
+
17
+ ### name
18
+
19
+ `string`
20
+
21
+ The name of the header whose value will be injected.
22
+
23
+ ## Returns
24
+
25
+ (`target`, `propertyKey`, `index`) => `void`
@@ -0,0 +1,31 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Method
6
+
7
+ # Function: Method()
8
+
9
+ > **Method**(`method`, `path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:127](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L127)
12
+
13
+ Indicates that the decorated function handles incoming HTTP requests for the specified HTTP method(s) at the given sub-path.
14
+
15
+ ## Parameters
16
+
17
+ ### method
18
+
19
+ `string` \| `string`[]
20
+
21
+ The HTTP method(s) to handle requests for.
22
+
23
+ ### path?
24
+
25
+ `string`
26
+
27
+ The sub-path that the route handles requests for.
28
+
29
+ ## Returns
30
+
31
+ (`target`, `propertyKey`, `descriptor`) => `void`
@@ -0,0 +1,25 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Model
6
+
7
+ # Function: Model()
8
+
9
+ > **Model**(`type`): \<`T`\>(`constructor`) => \{(...`args`): `(Anonymous class)`\<`T`\>; `modelClass`: `any`; `prototype`: `(Anonymous class)`\<`any`\>; \} & `T`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:150](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L150)
12
+
13
+ Indicates that the class utilizes is a manager for the specified class type.
14
+
15
+ ## Parameters
16
+
17
+ ### type
18
+
19
+ `any`
20
+
21
+ The data model class type to associate the class with.
22
+
23
+ ## Returns
24
+
25
+ \<`T`\>(`constructor`) => \{(...`args`): `(Anonymous class)`\<`T`\>; `modelClass`: `any`; `prototype`: `(Anonymous class)`\<`any`\>; \} & `T`
@@ -0,0 +1,25 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Options
6
+
7
+ # Function: Options()
8
+
9
+ > **Options**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:164](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L164)
12
+
13
+ Indicates that the decorated function handles incoming `OPTIONS` requests at the given sub-path.
14
+
15
+ ## Parameters
16
+
17
+ ### path?
18
+
19
+ `string`
20
+
21
+ The sub-path that the route will handle requests for.
22
+
23
+ ## Returns
24
+
25
+ (`target`, `propertyKey`, `descriptor`) => `void`
@@ -0,0 +1,26 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Param
6
+
7
+ # Function: Param()
8
+
9
+ > **Param**(`name?`): (`target`, `propertyKey`, `index`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:174](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L174)
12
+
13
+ Injects the value of the specified URI parameter with the given name as the value of the decorated argument. If no
14
+ name is specified the entire request parameter will be injected.
15
+
16
+ ## Parameters
17
+
18
+ ### name?
19
+
20
+ `string` \| `undefined`
21
+
22
+ The name of the URI parameter whose value will be injected.
23
+
24
+ ## Returns
25
+
26
+ (`target`, `propertyKey`, `index`) => `void`
@@ -0,0 +1,25 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Patch
6
+
7
+ # Function: Patch()
8
+
9
+ > **Patch**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:187](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L187)
12
+
13
+ Indicates that the decorated function handles incoming `PATCH` requests at the given sub-path.
14
+
15
+ ## Parameters
16
+
17
+ ### path?
18
+
19
+ `string`
20
+
21
+ The sub-path that the route will handle requests for.
22
+
23
+ ## Returns
24
+
25
+ (`target`, `propertyKey`, `descriptor`) => `void`
@@ -0,0 +1,25 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Post
6
+
7
+ # Function: Post()
8
+
9
+ > **Post**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:196](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L196)
12
+
13
+ Indicates that the decorated function handles incoming `POST` requests at the given sub-path.
14
+
15
+ ## Parameters
16
+
17
+ ### path?
18
+
19
+ `string`
20
+
21
+ The sub-path that the route will handle requests for.
22
+
23
+ ## Returns
24
+
25
+ (`target`, `propertyKey`, `descriptor`) => `void`
@@ -0,0 +1,31 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Protect
6
+
7
+ # Function: Protect()
8
+
9
+ > **Protect**(`acl?`): (`target`, `propertyKey?`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:222](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L222)
12
+
13
+ Apply this to any route handler class or an individual route handler function to indicate that it should be
14
+ protected by the AccessControlList security system. The `acl` parameter specifies the ACL governing access
15
+ to the HTTP resource(s) defined. If a class and a given route handler function both have this decorator
16
+ applied, the class ACL will be listed as the parent to the function's ACL object, thus inheriting
17
+ whatever permissions applied to the class level.
18
+
19
+ ## Parameters
20
+
21
+ ### acl?
22
+
23
+ `PartialACL` = `...`
24
+
25
+ The access control list to define for this route class or handler. Not specifying a value here
26
+ * will default to the behavior of denying anonymous access to the resource and allowing any authenticated
27
+ * user CRUD access.
28
+
29
+ ## Returns
30
+
31
+ (`target`, `propertyKey?`) => `void`
@@ -0,0 +1,25 @@
1
+ [**@rapidrest/service-core**](../../../../README.md)
2
+
3
+ ***
4
+
5
+ [@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Put
6
+
7
+ # Function: Put()
8
+
9
+ > **Put**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
10
+
11
+ Defined in: [src/decorators/RouteDecorators.ts:205](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L205)
12
+
13
+ Indicates that the decorated function handles incoming `PUT` requests at the given sub-path.
14
+
15
+ ## Parameters
16
+
17
+ ### path?
18
+
19
+ `string`
20
+
21
+ The sub-path that the route will handle requests for.
22
+
23
+ ## Returns
24
+
25
+ (`target`, `propertyKey`, `descriptor`) => `void`