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

package/docs/reference/classes/HttpRouter.md

@@ -6,7 +6,7 @@
 
 # Class: HttpRouter
 
-Defined in: [src/http/Router.ts:214](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L214)
+Defined in: [src/http/Router.ts:214](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L214)
 
 Thin Express-compatible wrapper over `uWS.TemplatedApp`.
 
@@ -29,7 +29,7 @@ Also supports:
 
 > **new HttpRouter**(`uwsApp`): `HttpRouter`
 
-Defined in: [src/http/Router.ts:226](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L226)
+Defined in: [src/http/Router.ts:226](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L226)
 
 #### Parameters
 
@@ -47,7 +47,7 @@ Defined in: [src/http/Router.ts:226](https://github.com/rapidrest/service-core/b
 
 > **listenPort**: `number` = `0`
 
-Defined in: [src/http/Router.ts:224](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L224)
+Defined in: [src/http/Router.ts:224](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L224)
 
 The port the server is currently listening on (set after a successful `listen()` call).
 
@@ -59,7 +59,7 @@ The port the server is currently listening on (set after a successful `listen()`
 
 > **get** **isListening**(): `boolean`
 
-Defined in: [src/http/Router.ts:231](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L231)
+Defined in: [src/http/Router.ts:231](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L231)
 
 Returns `true` if the server is currently listening.
 
@@ -73,7 +73,7 @@ Returns `true` if the server is currently listening.
 
 > **close**(): `void`
 
-Defined in: [src/http/Router.ts:471](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L471)
+Defined in: [src/http/Router.ts:471](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L471)
 
 Closes the listen socket, stopping the server from accepting new connections.
 
@@ -87,7 +87,7 @@ Closes the listen socket, stopping the server from accepting new connections.
 
 > **delete**(`routePath`, ...`handlers`): `this`
 
-Defined in: [src/http/Router.ts:275](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L275)
+Defined in: [src/http/Router.ts:275](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L275)
 
 #### Parameters
 
@@ -109,7 +109,7 @@ Defined in: [src/http/Router.ts:275](https://github.com/rapidrest/service-core/b
 
 > **get**(`routePath`, ...`handlers`): `this`
 
-Defined in: [src/http/Router.ts:257](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L257)
+Defined in: [src/http/Router.ts:257](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L257)
 
 #### Parameters
 
@@ -131,7 +131,7 @@ Defined in: [src/http/Router.ts:257](https://github.com/rapidrest/service-core/b
 
 > **head**(`routePath`, ...`handlers`): `this`
 
-Defined in: [src/http/Router.ts:287](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L287)
+Defined in: [src/http/Router.ts:287](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L287)
 
 #### Parameters
 
@@ -153,7 +153,7 @@ Defined in: [src/http/Router.ts:287](https://github.com/rapidrest/service-core/b
 
 > **listen**(`host`, `port`): `Promise`\<`void`\>
 
-Defined in: [src/http/Router.ts:450](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L450)
+Defined in: [src/http/Router.ts:450](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L450)
 
 Starts listening on the given host and port.
 Resolves when the server is ready; rejects if the port cannot be bound.
@@ -178,7 +178,7 @@ Resolves when the server is ready; rejects if the port cannot be bound.
 
 > **options**(`routePath`, ...`handlers`): `this`
 
-Defined in: [src/http/Router.ts:294](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L294)
+Defined in: [src/http/Router.ts:294](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L294)
 
 #### Parameters
 
@@ -200,7 +200,7 @@ Defined in: [src/http/Router.ts:294](https://github.com/rapidrest/service-core/b
 
 > **patch**(`routePath`, ...`handlers`): `this`
 
-Defined in: [src/http/Router.ts:281](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L281)
+Defined in: [src/http/Router.ts:281](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L281)
 
 #### Parameters
 
@@ -222,7 +222,7 @@ Defined in: [src/http/Router.ts:281](https://github.com/rapidrest/service-core/b
 
 > **post**(`routePath`, ...`handlers`): `this`
 
-Defined in: [src/http/Router.ts:263](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L263)
+Defined in: [src/http/Router.ts:263](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L263)
 
 #### Parameters
 
@@ -244,7 +244,7 @@ Defined in: [src/http/Router.ts:263](https://github.com/rapidrest/service-core/b
 
 > **put**(`routePath`, ...`handlers`): `this`
 
-Defined in: [src/http/Router.ts:269](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L269)
+Defined in: [src/http/Router.ts:269](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L269)
 
 #### Parameters
 
@@ -266,7 +266,7 @@ Defined in: [src/http/Router.ts:269](https://github.com/rapidrest/service-core/b
 
 > **static**(`basePath`): `this`
 
-Defined in: [src/http/Router.ts:420](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L420)
+Defined in: [src/http/Router.ts:420](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L420)
 
 Serves static files from a directory via a wildcard GET route.
 Files not found on disk return 404.
@@ -287,7 +287,7 @@ Files not found on disk return 404.
 
 > **use**(...`handlers`): `this`
 
-Defined in: [src/http/Router.ts:236](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L236)
+Defined in: [src/http/Router.ts:236](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L236)
 
 Register global middleware that runs before every route handler.
 
@@ -307,7 +307,7 @@ Register global middleware that runs before every route handler.
 
 > **ws**(`routePath`, `handlers`, `wsOptions?`, `upgradeAuth?`): `this`
 
-Defined in: [src/http/Router.ts:312](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/http/Router.ts#L312)
+Defined in: [src/http/Router.ts:312](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/http/Router.ts#L312)
 
 Registers a WebSocket route. Handlers follow the same `(req, res, next)` pattern
 as HTTP routes; they receive `req.websocket` containing the uWS WebSocket handle.

package/docs/reference/classes/JWTStrategy.md

@@ -6,7 +6,7 @@
 
 # Class: JWTStrategy
 
-Defined in: [src/auth/JWTStrategy.ts:63](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L63)
+Defined in: [src/auth/JWTStrategy.ts:63](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L63)
 
 JWT authentication strategy. Performs JWT verification and searches for a token by one of the
 following methods (in order of precedence):
@@ -27,7 +27,7 @@ Jean-Philippe Steinmetz
 
 > **new JWTStrategy**(`options?`): `JWTStrategy`
 
-Defined in: [src/auth/JWTStrategy.ts:71](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L71)
+Defined in: [src/auth/JWTStrategy.ts:71](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L71)
 
 #### Parameters
 
@@ -45,7 +45,7 @@ Defined in: [src/auth/JWTStrategy.ts:71](https://github.com/rapidrest/service-co
 
 > `readonly` **name**: `string` = `"jwt"`
 
-Defined in: [src/auth/JWTStrategy.ts:67](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L67)
+Defined in: [src/auth/JWTStrategy.ts:67](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L67)
 
 ## Methods
 
@@ -53,7 +53,7 @@ Defined in: [src/auth/JWTStrategy.ts:67](https://github.com/rapidrest/service-co
 
 > **authenticate**(`req`, `res`, `required?`): `Promise`\<[`JWTAuthResult`](../interfaces/JWTAuthResult.md) \| `undefined`\>
 
-Defined in: [src/auth/JWTStrategy.ts:134](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L134)
+Defined in: [src/auth/JWTStrategy.ts:134](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L134)
 
 #### Parameters
 
@@ -79,7 +79,7 @@ Defined in: [src/auth/JWTStrategy.ts:134](https://github.com/rapidrest/service-c
 
 > **authenticateSync**(`req`, `res`, `required?`): [`JWTAuthResult`](../interfaces/JWTAuthResult.md) \| `undefined`
 
-Defined in: [src/auth/JWTStrategy.ts:169](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L169)
+Defined in: [src/auth/JWTStrategy.ts:169](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L169)
 
 #### Parameters
 

package/docs/reference/classes/JWTStrategyOptions.md

@@ -6,7 +6,7 @@
 
 # Class: JWTStrategyOptions
 
-Defined in: [src/auth/JWTStrategy.ts:19](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L19)
+Defined in: [src/auth/JWTStrategy.ts:19](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L19)
 
 Describes the configuration options that can be used to initialize JWTStrategy.
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz
 
 > **allowQueryParam**: `boolean` = `false`
 
-Defined in: [src/auth/JWTStrategy.ts:37](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L37)
+Defined in: [src/auth/JWTStrategy.ts:37](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L37)
 
 Set to `true` to allow tokens to be supplied via the `queryKey` URL parameter.
 Disabled by default — query parameters appear in server logs, browser history, and
@@ -42,7 +42,7 @@ Referer headers, which permanently exposes tokens outside the application.
 
 > `optional` **config?**: `JWTUtilsConfig`
 
-Defined in: [src/auth/JWTStrategy.ts:21](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L21)
+Defined in: [src/auth/JWTStrategy.ts:21](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L21)
 
 The configuration options to pass to the JWTUtils library during token verification.
 
@@ -52,7 +52,7 @@ The configuration options to pass to the JWTUtils library during token verificat
 
 > **cookieName**: `string` = `"jwt"`
 
-Defined in: [src/auth/JWTStrategy.ts:27](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L27)
+Defined in: [src/auth/JWTStrategy.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L27)
 
 The name of the cookie to retrieve the token from when using cookie based authentication. Default value is `jwt`.
 
@@ -62,7 +62,7 @@ The name of the cookie to retrieve the token from when using cookie based authen
 
 > **cookieSecure**: `boolean` = `false`
 
-Defined in: [src/auth/JWTStrategy.ts:29](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L29)
+Defined in: [src/auth/JWTStrategy.ts:29](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L29)
 
 The name of the secured cookie to retreive the token from when using cookie based authentication.
 
@@ -72,7 +72,7 @@ The name of the secured cookie to retreive the token from when using cookie base
 
 > **headerKey**: `string` = `"authorization"`
 
-Defined in: [src/auth/JWTStrategy.ts:23](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L23)
+Defined in: [src/auth/JWTStrategy.ts:23](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L23)
 
 The name of the header to look for when performing header based authentication. Default value is `Authorization`.
 
@@ -82,7 +82,7 @@ The name of the header to look for when performing header based authentication.
 
 > **headerScheme**: `string` = "(jwt\|bearer)"
 
-Defined in: [src/auth/JWTStrategy.ts:25](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L25)
+Defined in: [src/auth/JWTStrategy.ts:25](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L25)
 
 The authorization scheme type when using header based authentication. Default value is `jwt`.
 
@@ -92,6 +92,6 @@ The authorization scheme type when using header based authentication. Default va
 
 > **queryKey**: `string` = `"auth_token"`
 
-Defined in: [src/auth/JWTStrategy.ts:31](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/JWTStrategy.ts#L31)
+Defined in: [src/auth/JWTStrategy.ts:31](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/JWTStrategy.ts#L31)
 
 The name of the request query parameter to retrieve the token from when using query based authentication. Default value is `auth_token`.

package/docs/reference/classes/MetricsRoute.md

@@ -6,12 +6,12 @@
 
 # Class: MetricsRoute
 
-Defined in: [src/routes/MetricsRoute.ts:19](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/MetricsRoute.ts#L19)
+Defined in: [src/routes/MetricsRoute.ts:19](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/MetricsRoute.ts#L19)
 
-Handles all REST API requests for the endpoint `/metrics'. This route handler produces Prometheus compatible metrics
+Handles all REST API requests for the endpoint `/metrics'. This route handler produces Prometheus compatible metrics
 for use with a Prometheus based server.
 
-Services that wish to provide metrics to be exposed via this route can register them using the global registry
+Services that wish to provide metrics to be exposed via this route can register them using the global registry
 from the provided `prom-client` dependency. See the `prom-client` documentation for more details.
 
 ## Constructors
@@ -20,7 +20,7 @@ from the provided `prom-client` dependency. See the `prom-client` documentation
 
 > **new MetricsRoute**(): `MetricsRoute`
 
-Defined in: [src/routes/MetricsRoute.ts:30](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/MetricsRoute.ts#L30)
+Defined in: [src/routes/MetricsRoute.ts:30](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/MetricsRoute.ts#L30)
 
 #### Returns
 

package/docs/reference/classes/ModelRoute.md

@@ -6,7 +6,7 @@
 
 # Abstract Class: ModelRoute\<T\>
 
-Defined in: [src/routes/ModelRoute.ts:117](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L117)
+Defined in: [src/routes/ModelRoute.ts:117](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L117)
 
 The `ModelRoute` is an abstract base class that provides a set of built-in route behavior functions for handling
 requests for a given data model that is managed by a persistent datastore.
@@ -46,7 +46,7 @@ Jean-Philippe Steinmetz
 
 > `protected` `optional` **aclUtils?**: [`ACLUtils`](ACLUtils.md)
 
-Defined in: [src/routes/ModelRoute.ts:119](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L119)
+Defined in: [src/routes/ModelRoute.ts:119](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L119)
 
 ***
 
@@ -54,7 +54,7 @@ Defined in: [src/routes/ModelRoute.ts:119](https://github.com/rapidrest/service-
 
 > `protected` `optional` **cacheClient?**: `Redis`
 
-Defined in: [src/routes/ModelRoute.ts:123](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L123)
+Defined in: [src/routes/ModelRoute.ts:123](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L123)
 
 The redis client that will be used as a 2nd level cache for all cacheable models.
 
@@ -64,7 +64,7 @@ The redis client that will be used as a 2nd level cache for all cacheable models
 
 > `protected` `optional` **config?**: `any`
 
-Defined in: [src/routes/ModelRoute.ts:127](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L127)
+Defined in: [src/routes/ModelRoute.ts:127](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L127)
 
 The global application configuration.
 
@@ -74,7 +74,7 @@ The global application configuration.
 
 > `protected` **defaultACLUid**: `string` = `""`
 
-Defined in: [src/routes/ModelRoute.ts:130](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L130)
+Defined in: [src/routes/ModelRoute.ts:130](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L130)
 
 The unique identifier of the default ACL for the model type.
 
@@ -84,7 +84,7 @@ The unique identifier of the default ACL for the model type.
 
 > `protected` **logger**: `any`
 
-Defined in: [src/routes/ModelRoute.ts:133](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L133)
+Defined in: [src/routes/ModelRoute.ts:133](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L133)
 
 ***
 
@@ -92,7 +92,7 @@ Defined in: [src/routes/ModelRoute.ts:133](https://github.com/rapidrest/service-
 
 > `protected` `optional` **notificationUtils?**: [`NotificationUtils`](NotificationUtils.md)
 
-Defined in: [src/routes/ModelRoute.ts:136](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L136)
+Defined in: [src/routes/ModelRoute.ts:136](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L136)
 
 ***
 
@@ -100,7 +100,7 @@ Defined in: [src/routes/ModelRoute.ts:136](https://github.com/rapidrest/service-
 
 > `protected` `optional` **objectFactory?**: [`ObjectFactory`](ObjectFactory.md)
 
-Defined in: [src/routes/ModelRoute.ts:139](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L139)
+Defined in: [src/routes/ModelRoute.ts:139](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L139)
 
 ***
 
@@ -108,7 +108,7 @@ Defined in: [src/routes/ModelRoute.ts:139](https://github.com/rapidrest/service-
 
 > `protected` `optional` **repoUtils?**: [`RepoUtils`](RepoUtils.md)\<`T`\>
 
-Defined in: [src/routes/ModelRoute.ts:145](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L145)
+Defined in: [src/routes/ModelRoute.ts:145](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L145)
 
 The repository utility class to use for common operations.
 
@@ -118,7 +118,7 @@ The repository utility class to use for common operations.
 
 > `abstract` `protected` `readonly` **repoUtilsClass**: `any`
 
-Defined in: [src/routes/ModelRoute.ts:142](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L142)
+Defined in: [src/routes/ModelRoute.ts:142](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L142)
 
 The class of the RepoUtils to use when instantiating the utility.
 
@@ -128,7 +128,7 @@ The class of the RepoUtils to use when instantiating the utility.
 
 > `protected` **trackChanges**: `number` = `0`
 
-Defined in: [src/routes/ModelRoute.ts:151](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L151)
+Defined in: [src/routes/ModelRoute.ts:151](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L151)
 
 The number of previous document versions to store in the database. A negative value indicates storing all
 versions, a value of `0` stores no versions.
@@ -139,7 +139,7 @@ versions, a value of `0` stores no versions.
 
 > `protected` **trustedRoles**: `string`[]
 
-Defined in: [src/routes/ModelRoute.ts:154](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L154)
+Defined in: [src/routes/ModelRoute.ts:154](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L154)
 
 ## Accessors
 
@@ -149,7 +149,7 @@ Defined in: [src/routes/ModelRoute.ts:154](https://github.com/rapidrest/service-
 
 > **get** `protected` **modelClass**(): `any`
 
-Defined in: [src/routes/ModelRoute.ts:159](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L159)
+Defined in: [src/routes/ModelRoute.ts:159](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L159)
 
 The class type of the model this route is associated with.
 
@@ -163,7 +163,7 @@ The class type of the model this route is associated with.
 
 > `protected` **doBulkCreate**(`objs`, `options`): `Promise`\<`T`[]\>
 
-Defined in: [src/routes/ModelRoute.ts:258](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L258)
+Defined in: [src/routes/ModelRoute.ts:258](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L258)
 
 Attempts to store a collection of objects provided in `options.req.body` into the datastore. Upon success, sets the newly persisted
 object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
@@ -193,7 +193,7 @@ The options to process the request using.
 
 > `protected` **doBulkUpdate**(`objs`, `options`): `Promise`\<`T`[]\>
 
-Defined in: [src/routes/ModelRoute.ts:517](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L517)
+Defined in: [src/routes/ModelRoute.ts:517](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L517)
 
 Attempts to modify a collection of existing data model objects.
 
@@ -221,7 +221,7 @@ The options to process the request using.
 
 > `protected` **doCount**(`options`): `Promise`\<[`HttpResponse`](../interfaces/HttpResponse.md)\>
 
-Defined in: [src/routes/ModelRoute.ts:191](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L191)
+Defined in: [src/routes/ModelRoute.ts:191](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L191)
 
 Attempts to retrieve the number of data model objects matching the given set of criteria as specified in the
 request `query`. Any results that have been found are set to the `content-length` header of the `res` argument.
@@ -244,7 +244,7 @@ The options to process the request using.
 
 > `protected` **doCreate**(`obj`, `options`): `Promise`\<`T` \| `T`[]\>
 
-Defined in: [src/routes/ModelRoute.ts:288](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L288)
+Defined in: [src/routes/ModelRoute.ts:288](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L288)
 
 Attempts to store one or more objects provided in `options.req.body` into the datastore. Upon success, sets the newly persisted
 object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
@@ -274,7 +274,7 @@ The options to process the request using.
 
 > `protected` **doCreateObject**(`obj`, `options`): `Promise`\<`T`\>
 
-Defined in: [src/routes/ModelRoute.ts:228](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L228)
+Defined in: [src/routes/ModelRoute.ts:228](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L228)
 
 Attempts to store an object provided in `options.req.body` into the datastore. Upon success, sets the newly persisted
 object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
@@ -304,7 +304,7 @@ The options to process the request using.
 
 > `protected` **doDelete**(`id`, `options`): `Promise`\<`void`\>
 
-Defined in: [src/routes/ModelRoute.ts:313](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L313)
+Defined in: [src/routes/ModelRoute.ts:313](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L313)
 
 Attempts to delete an existing data model object with a given unique identifier encoded by the URI parameter
 `id`.
@@ -333,7 +333,7 @@ The options to process the request using.
 
 > `protected` **doExists**(`id`, `options`): `Promise`\<`any`\>
 
-Defined in: [src/routes/ModelRoute.ts:359](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L359)
+Defined in: [src/routes/ModelRoute.ts:359](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L359)
 
 Attempts to determine if an existing object with the given unique identifier exists.
 
@@ -361,7 +361,7 @@ The options to process the request using.
 
 > `protected` **doFindAll**(`options`): `Promise`\<`T`[]\>
 
-Defined in: [src/routes/ModelRoute.ts:400](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L400)
+Defined in: [src/routes/ModelRoute.ts:400](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L400)
 
 Attempts to retrieve all data model objects matching the given set of criteria as specified in the request
 `query`. Any results that have been found are set to the `result` property of the `res` argument. `result` is
@@ -385,7 +385,7 @@ The options to process the request using.
 
 > `protected` **doFindById**(`id`, `options`): `Promise`\<`T` \| `null`\>
 
-Defined in: [src/routes/ModelRoute.ts:435](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L435)
+Defined in: [src/routes/ModelRoute.ts:435](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L435)
 
 Attempts to retrieve a single data model object as identified by the `id` parameter in the URI.
 
@@ -411,7 +411,7 @@ The options to process the request using.
 
 > `protected` **doTruncate**(`options`): `Promise`\<`void`\>
 
-Defined in: [src/routes/ModelRoute.ts:477](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L477)
+Defined in: [src/routes/ModelRoute.ts:477](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L477)
 
 Attempts to remove all entries of the data model type from the datastore matching the given
 parameters and query.
@@ -434,7 +434,7 @@ The options to process the request using.
 
 > `protected` **doUpdate**(`id`, `obj`, `options`): `Promise`\<`T`\>
 
-Defined in: [src/routes/ModelRoute.ts:545](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L545)
+Defined in: [src/routes/ModelRoute.ts:545](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L545)
 
 Attempts to modify an existing data model object as identified by the `id` parameter in the URI.
 
@@ -466,7 +466,7 @@ The options to process the request using.
 
 > `protected` **doUpdateProperty**(`id`, `propertyName`, `value`, `options`): `Promise`\<`T`\>
 
-Defined in: [src/routes/ModelRoute.ts:596](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L596)
+Defined in: [src/routes/ModelRoute.ts:596](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L596)
 
 Attempts to modify a single property of an existing data model object as identified by the `id` parameter in the URI.
 
@@ -508,7 +508,7 @@ The options to process the request using.
 
 > `protected` **doValidate**(`objs`, `options?`): `Promise`\<`void`\>
 
-Defined in: [src/routes/ModelRoute.ts:642](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/ModelRoute.ts#L642)
+Defined in: [src/routes/ModelRoute.ts:642](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/ModelRoute.ts#L642)
 
 Calls `repoUtils.validate()` to validate the object(s) provided.