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

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md

@@ -6,7 +6,7 @@
 
 # Interface: IndexInfo
 
-Defined in: [src/decorators/PersistenceDecorators.ts:50](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L50)
+Defined in: [src/decorators/PersistenceDecorators.ts:50](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L50)
 
 Describes a single database index of a model class.
 
@@ -16,7 +16,7 @@ Describes a single database index of a model class.
 
 > **columns**: `string`[]
 
-Defined in: [src/decorators/PersistenceDecorators.ts:54](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L54)
+Defined in: [src/decorators/PersistenceDecorators.ts:54](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L54)
 
 The list of class properties that make up the index.
 
@@ -26,7 +26,7 @@ The list of class properties that make up the index.
 
 > `optional` **name?**: `string`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:52](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L52)
+Defined in: [src/decorators/PersistenceDecorators.ts:52](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L52)
 
 The explicit name of the index, if any.
 
@@ -36,6 +36,6 @@ The explicit name of the index, if any.
 
 > **options**: [`IndexOptions`](IndexOptions.md)
 
-Defined in: [src/decorators/PersistenceDecorators.ts:56](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L56)
+Defined in: [src/decorators/PersistenceDecorators.ts:56](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L56)
 
 The options that the index was declared with.

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: IndexOptions
 
-Defined in: [src/decorators/PersistenceDecorators.ts:24](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L24)
+Defined in: [src/decorators/PersistenceDecorators.ts:24](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L24)
 
 The set of options available when declaring a database index via the `@Index` decorator.
 
@@ -16,7 +16,7 @@ The set of options available when declaring a database index via the `@Index` de
 
 > `optional` **background?**: `boolean`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:30](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L30)
+Defined in: [src/decorators/PersistenceDecorators.ts:30](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L30)
 
 Set to `true` to build the index in the background. (MongoDB only)
 
@@ -26,7 +26,7 @@ Set to `true` to build the index in the background. (MongoDB only)
 
 > `optional` **expireAfterSeconds?**: `number`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L32)
+Defined in: [src/decorators/PersistenceDecorators.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L32)
 
 The time, in seconds, after which indexed documents will be automatically deleted. (MongoDB only)
 
@@ -36,7 +36,7 @@ The time, in seconds, after which indexed documents will be automatically delete
 
 > `optional` **sparse?**: `boolean`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:28](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L28)
+Defined in: [src/decorators/PersistenceDecorators.ts:28](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L28)
 
 Set to `true` to only index documents in which the indexed properties exist. (MongoDB only)
 
@@ -46,6 +46,6 @@ Set to `true` to only index documents in which the indexed properties exist. (Mo
 
 > `optional` **unique?**: `boolean`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:26](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L26)
+Defined in: [src/decorators/PersistenceDecorators.ts:26](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L26)
 
 Set to `true` to enforce that all values of the indexed properties are unique.

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/After.md

@@ -8,7 +8,7 @@
 
 > **After**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:13](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L13)
+Defined in: [src/decorators/RouteDecorators.ts:13](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L13)
 
 Indicates a provided function or list of functions to execute *after* the decorated function and before the response
 is sent to a client. Note that the function must call `next()` in order for this decorator to work.

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Auth.md

@@ -8,7 +8,7 @@
 
 > **Auth**(`strategies`, `require?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:33](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L33)
+Defined in: [src/decorators/RouteDecorators.ts:33](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L33)
 
 Applies PassportJS authentication to the decorated route or method for the provided strategy or list of strategies
 should be attempted before processing the route.

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/AuthResult.md

@@ -8,7 +8,7 @@
 
 > **AuthResult**(`target`, `propertyKey`, `index`): `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:45](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L45)
+Defined in: [src/decorators/RouteDecorators.ts:45](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L45)
 
 Injects the authenticated authentication result as the value of the decorated argument.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Before.md

@@ -8,7 +8,7 @@
 
 > **Before**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:56](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L56)
+Defined in: [src/decorators/RouteDecorators.ts:56](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L56)
 
 Indicates a provided function or list of functions to execute *before* the decorated function.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/ContentType.md

@@ -8,7 +8,7 @@
 
 > **ContentType**(`type`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:73](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L73)
+Defined in: [src/decorators/RouteDecorators.ts:73](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L73)
 
 Indicates that the decorated function will return content encoded with the specified content type.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Delete.md

@@ -8,7 +8,7 @@
 
 > **Delete**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:86](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L86)
+Defined in: [src/decorators/RouteDecorators.ts:86](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L86)
 
 Indicates that the decorated function handles incoming `DELETE` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md

@@ -8,7 +8,7 @@
 
 > **Get**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:95](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L95)
+Defined in: [src/decorators/RouteDecorators.ts:95](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L95)
 
 Indicates that the decorated function handles incoming `GET` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md

@@ -8,7 +8,7 @@
 
 > **Head**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:104](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L104)
+Defined in: [src/decorators/RouteDecorators.ts:104](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L104)
 
 Indicates that the decorated function handles incoming `HEAD` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md

@@ -8,7 +8,7 @@
 
 > **Header**(`name`): (`target`, `propertyKey`, `index`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:113](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L113)
+Defined in: [src/decorators/RouteDecorators.ts:113](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L113)
 
 Injects the value of the specified request header with the given name as the value of the decorated argument.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md

@@ -8,7 +8,7 @@
 
 > **Method**(`method`, `path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:127](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L127)
+Defined in: [src/decorators/RouteDecorators.ts:127](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L127)
 
 Indicates that the decorated function handles incoming HTTP requests for the specified HTTP method(s) at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md

@@ -8,7 +8,7 @@
 
 > **Model**(`type`): \<`T`\>(`constructor`) => \{(...`args`): `(Anonymous class)`\<`T`\>; `modelClass`: `any`; `prototype`: `(Anonymous class)`\<`any`\>; \} & `T`
 
-Defined in: [src/decorators/RouteDecorators.ts:150](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L150)
+Defined in: [src/decorators/RouteDecorators.ts:150](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L150)
 
 Indicates that the class utilizes is a manager for the specified class type.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md

@@ -8,7 +8,7 @@
 
 > **Options**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:164](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L164)
+Defined in: [src/decorators/RouteDecorators.ts:164](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L164)
 
 Indicates that the decorated function handles incoming `OPTIONS` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md

@@ -8,7 +8,7 @@
 
 > **Param**(`name?`): (`target`, `propertyKey`, `index`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:174](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L174)
+Defined in: [src/decorators/RouteDecorators.ts:174](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L174)
 
 Injects the value of the specified URI parameter with the given name as the value of the decorated argument. If no
 name is specified the entire request parameter will be injected.

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md

@@ -8,7 +8,7 @@
 
 > **Patch**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:187](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L187)
+Defined in: [src/decorators/RouteDecorators.ts:187](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L187)
 
 Indicates that the decorated function handles incoming `PATCH` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md

@@ -8,7 +8,7 @@
 
 > **Post**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:196](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L196)
+Defined in: [src/decorators/RouteDecorators.ts:196](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L196)
 
 Indicates that the decorated function handles incoming `POST` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md

@@ -8,7 +8,7 @@
 
 > **Protect**(`acl?`): (`target`, `propertyKey?`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:222](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L222)
+Defined in: [src/decorators/RouteDecorators.ts:222](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L222)
 
 Apply this to any route handler class or an individual route handler function to indicate that it should be
 protected by the AccessControlList security system. The `acl` parameter specifies the ACL governing access

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md

@@ -8,7 +8,7 @@
 
 > **Put**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:205](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L205)
+Defined in: [src/decorators/RouteDecorators.ts:205](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L205)
 
 Indicates that the decorated function handles incoming `PUT` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md

@@ -8,7 +8,7 @@
 
 > **Query**(`name?`): (`target`, `propertyKey`, `index`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:265](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L265)
+Defined in: [src/decorators/RouteDecorators.ts:265](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L265)
 
 Injects the value of the specified query parameter with the given name as the value of the decorated argument. If
 no name is specified the entire request query will be injected.

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md

@@ -8,7 +8,7 @@
 
 > **Request**(`target`, `propertyKey`, `index`): `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:276](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L276)
+Defined in: [src/decorators/RouteDecorators.ts:276](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L276)
 
 Injects the Express request object as the value of the decorated argument.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md

@@ -8,7 +8,7 @@
 
 > **RequiresRole**(`roles`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:297](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L297)
+Defined in: [src/decorators/RouteDecorators.ts:297](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L297)
 
 Indicates that the client must be an authenticated user with at least one of the specified role(s) to process the
 request.

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md

@@ -8,7 +8,7 @@
 
 > **Response**(`target`, `propertyKey`, `index`): `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:285](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L285)
+Defined in: [src/decorators/RouteDecorators.ts:285](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L285)
 
 Injects the Express response object as the value of the decorated argument.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md

@@ -8,7 +8,7 @@
 
 > **Route**(`paths`): (`target`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:310](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L310)
+Defined in: [src/decorators/RouteDecorators.ts:310](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L310)
 
 Indicates that the decorated class contains Express route definitions.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md

@@ -8,7 +8,7 @@
 
 > **Socket**(`target`, `propertyKey`, `index`): `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:323](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L323)
+Defined in: [src/decorators/RouteDecorators.ts:323](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L323)
 
 Injects the underlying Socket object associated with the request as the value of the decorated argument.
 When the handler function is for a WebSocket request, the returned socket will be the newly established

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md

@@ -8,7 +8,7 @@
 
 > **User**(`target`, `propertyKey`, `index`): `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:332](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L332)
+Defined in: [src/decorators/RouteDecorators.ts:332](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L332)
 
 Injects the authenticated user object as the value of the decorated argument.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md

@@ -8,7 +8,7 @@
 
 > **Validate**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:343](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L343)
+Defined in: [src/decorators/RouteDecorators.ts:343](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L343)
 
 Indicates a validation function to execute in order to verify an incoming requests payload.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md

@@ -8,7 +8,7 @@
 
 > **WebSocket**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:356](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/RouteDecorators.ts#L356)
+Defined in: [src/decorators/RouteDecorators.ts:356](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/RouteDecorators.ts#L356)
 
 Indicates that the decorated function handles incoming `WebSocket` upgrade requests at the given sub-path.
 

package/docs/reference/classes/ACLUtils.md

@@ -6,7 +6,7 @@
 
 # Class: ACLUtils
 
-Defined in: [src/security/ACLUtils.ts:22](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L22)
+Defined in: [src/security/ACLUtils.ts:22](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/ACLUtils.ts#L22)
 
 Common utility functions for working with `AccessControlList` objects and validating user permissions.
 
@@ -26,7 +26,7 @@ Common utility functions for working with `AccessControlList` objects and valida
 
 > **checkRequestPerms**(`uid`, `user`, `req`): `Promise`\<`boolean`\>
 
-Defined in: [src/security/ACLUtils.ts:73](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L73)
+Defined in: [src/security/ACLUtils.ts:73](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/ACLUtils.ts#L73)
 
 Validates that the user has permission to perform the request operation against the URL path for the
 provided request. If ACLUtils has not been initialized or the `acl` datastore has not been configured
@@ -48,7 +48,7 @@ The user to validate.
 
 ##### req
 
-`HttpRequest`
+[`HttpRequest`](../interfaces/HttpRequest.md)
 
 The request whose URL path and method will be verified.
 
@@ -62,7 +62,7 @@ The request whose URL path and method will be verified.
 
 > **findACL**(`entityId`, `parentUids?`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
 
-Defined in: [src/security/ACLUtils.ts:195](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L195)
+Defined in: [src/security/ACLUtils.ts:195](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/ACLUtils.ts#L195)
 
 Retrieves the access control list with the associated identifier and populates the parent(s).
 
@@ -90,7 +90,7 @@ The list of already found parent UIDs. This is used to break circular dependenci
 
 > **getRecord**(`acl`, `user`): [`ACLRecord`](../interfaces/ACLRecord.md) \| `null`
 
-Defined in: [src/security/ACLUtils.ts:459](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L459)
+Defined in: [src/security/ACLUtils.ts:459](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/ACLUtils.ts#L459)
 
 Retrieves the first available record in the provided ACL associated with the provided user.
 
@@ -120,7 +120,7 @@ The ACL record associated with the given user if found, otherwise `undefined`.
 
 > **hasPermission**(`user`, `acl`, `action`): `Promise`\<`boolean`\>
 
-Defined in: [src/security/ACLUtils.ts:127](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L127)
+Defined in: [src/security/ACLUtils.ts:127](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/ACLUtils.ts#L127)
 
 Validates that the user has permission to perform the provided action using the given access control list.
 
@@ -156,7 +156,7 @@ The action that the user desires permission for.
 
 > **populateParent**(`acl`, `parentUids?`): `Promise`\<`void`\>
 
-Defined in: [src/security/ACLUtils.ts:479](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L479)
+Defined in: [src/security/ACLUtils.ts:479](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/ACLUtils.ts#L479)
 
 Attempts to retrieve the parent access control list for the given ACL object.
 
@@ -184,7 +184,7 @@ The list of already found parent UIDs. This is used to break circular dependenci
 
 > **removeACL**(`uid`): `Promise`\<`void`\>
 
-Defined in: [src/security/ACLUtils.ts:247](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L247)
+Defined in: [src/security/ACLUtils.ts:247](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/ACLUtils.ts#L247)
 
 Deletes the ACL with the given identifier from the database.
 
@@ -206,7 +206,7 @@ The unique identifier of the ACL to remove.
 
 > **saveACL**(`acl`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
 
-Defined in: [src/security/ACLUtils.ts:333](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L333)
+Defined in: [src/security/ACLUtils.ts:333](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/ACLUtils.ts#L333)
 
 Stores the given access control list into the ACL database.
 
@@ -230,7 +230,7 @@ Returns the ACL that was stored in the database.
 
 > **saveDefaultACL**(`acl`): `Promise`\<[`AccessControlList`](../interfaces/AccessControlList.md) \| `null`\>
 
-Defined in: [src/security/ACLUtils.ts:399](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/ACLUtils.ts#L399)
+Defined in: [src/security/ACLUtils.ts:399](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/security/ACLUtils.ts#L399)
 
 Stores the given default access control list into the ACL database. A default ACL is a special type of ACL
 that is primarily defined and maintained within the code but allows for user-specific overrides. To accomplish

package/docs/reference/classes/AdminRoute.md

@@ -6,7 +6,7 @@
 
 # Class: AdminRoute
 
-Defined in: [src/routes/AdminRoute.ts:50](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/AdminRoute.ts#L50)
+Defined in: [src/routes/AdminRoute.ts:50](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/AdminRoute.ts#L50)
 
 The `AdminRoute` provides a default `/admin` endpoint that gives trusted users the following abilities:
 
@@ -26,7 +26,7 @@ Jean-Philippe Steinmetz
 
 > **new AdminRoute**(`releaseNotes`): `AdminRoute`
 
-Defined in: [src/routes/AdminRoute.ts:82](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/AdminRoute.ts#L82)
+Defined in: [src/routes/AdminRoute.ts:82](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/AdminRoute.ts#L82)
 
 Constructs a new `ReleaseNotesRoute` object with the specified defaults.
 
@@ -48,4 +48,4 @@ The ReleaseNotes specification object to serve.
 
 > `protected` `optional` **cacheClient?**: `Redis`
 
-Defined in: [src/routes/AdminRoute.ts:55](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/AdminRoute.ts#L55)
+Defined in: [src/routes/AdminRoute.ts:55](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/AdminRoute.ts#L55)

package/docs/reference/classes/AuthMiddleware.md

@@ -6,7 +6,7 @@
 
 # Class: AuthMiddleware
 
-Defined in: [src/auth/AuthMiddleware.ts:19](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L19)
+Defined in: [src/auth/AuthMiddleware.ts:19](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthMiddleware.ts#L19)
 
 A set of common utilities for performing authentication using one or more strategies.
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > `readonly` **strategies**: `Map`\<`string`, [`AuthStrategy`](../interfaces/AuthStrategy.md)\>
 
-Defined in: [src/auth/AuthMiddleware.ts:30](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L30)
+Defined in: [src/auth/AuthMiddleware.ts:30](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthMiddleware.ts#L30)
 
 The authentication strategies that have been registered.
 
@@ -38,9 +38,9 @@ The authentication strategies that have been registered.
 
 ### authenticate()
 
-> **authenticate**(`strategies`, `req`, `res?`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `Promise`\<[`AuthResult`](../interfaces/AuthResult.md)\> \| `undefined`
+> **authenticate**(`strategies`, `req`, `res?`, `required?`): `Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
 
-Defined in: [src/auth/AuthMiddleware.ts:54](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L54)
+Defined in: [src/auth/AuthMiddleware.ts:54](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthMiddleware.ts#L54)
 
 Performs authentication of the given request using one of the provided strategies.
 
@@ -54,13 +54,13 @@ The list of strategy names to attempt authentication with.
 
 ##### req
 
-`HttpRequest`
+[`HttpRequest`](../interfaces/HttpRequest.md)
 
 The request containing data to perform authenticate with.
 
 ##### res?
 
-`HttpResponse`
+[`HttpResponse`](../interfaces/HttpResponse.md)
 
 The response to use when writing back directly to the client.
 
@@ -72,20 +72,62 @@ Set to `true` to if authentication is required to pass, otherwise set to `false`
 
 #### Returns
 
-[`AuthResult`](../interfaces/AuthResult.md) \| `Promise`\<[`AuthResult`](../interfaces/AuthResult.md)\> \| `undefined`
+`Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
+
+***
+
+### authenticateSync()
+
+> **authenticateSync**(`strategies`, `req`, `res?`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
+
+Defined in: [src/auth/AuthMiddleware.ts:92](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthMiddleware.ts#L92)
+
+Performs authentication of the given request using one of the provided strategies.
+
+This is the synchronous version of `authenticate` that performs blocking based authentication.
+
+#### Parameters
+
+##### strategies
+
+`string`[]
+
+The list of strategy names to attempt authentication with.
+
+##### req
+
+[`HttpRequest`](../interfaces/HttpRequest.md)
+
+The request containing data to perform authenticate with.
+
+##### res?
+
+[`HttpResponse`](../interfaces/HttpResponse.md)
+
+The response to use when writing back directly to the client.
+
+##### required?
+
+`boolean`
+
+Set to `true` to if authentication is required to pass, otherwise set to `false`.
+
+#### Returns
+
+[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
 
 ***
 
 ### authWebSocket()
 
-> **authWebSocket**(`required`): `RequestHandler`
+> **authWebSocket**(`required`): [`RequestHandler`](../type-aliases/RequestHandler.md)
 
-Defined in: [src/auth/AuthMiddleware.ts:95](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L95)
+Defined in: [src/auth/AuthMiddleware.ts:133](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthMiddleware.ts#L133)
 
-Returns a request handler function that will perform authentication of a websocket connection. Authentication
+Returns a request handler function that will perform authentication of a websocket connection. Authentication
 can be handled in two ways:
 
-1. Authorization header
+1. Authorization header
 2. Negotiation via handshake
 
 This middleware function primarily provides the implementation for item 2 above.
@@ -100,7 +142,7 @@ Set to `true` to indicate that auth is required, otherwise `false`.
 
 #### Returns
 
-`RequestHandler`
+[`RequestHandler`](../type-aliases/RequestHandler.md)
 
 ***
 
@@ -108,7 +150,7 @@ Set to `true` to indicate that auth is required, otherwise `false`.
 
 > **register**(`name`, `strategy`): `void`
 
-Defined in: [src/auth/AuthMiddleware.ts:239](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthMiddleware.ts#L239)
+Defined in: [src/auth/AuthMiddleware.ts:277](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/AuthMiddleware.ts#L277)
 
 Registers the provided authentication strategy to be used