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

package/docs/reference/classes/BasicStrategyOptions.md

@@ -6,7 +6,7 @@
 
 # Class: BasicStrategyOptions
 
-Defined in: [src/auth/BasicStrategy.ts:13](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/BasicStrategy.ts#L13)
+Defined in: [src/auth/BasicStrategy.ts:13](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/BasicStrategy.ts#L13)
 
 Describes the configuration options that can be used to initialize BasicStrategy.
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz
 
 > **allowQueryParam**: `boolean` = `false`
 
-Defined in: [src/auth/BasicStrategy.ts:25](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/BasicStrategy.ts#L25)
+Defined in: [src/auth/BasicStrategy.ts:25](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/BasicStrategy.ts#L25)
 
 Set to `true` to allow credentials 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 credentials outside the application.
 
 > **headerKey**: `string` = `"authorization"`
 
-Defined in: [src/auth/BasicStrategy.ts:15](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/BasicStrategy.ts#L15)
+Defined in: [src/auth/BasicStrategy.ts:15](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/BasicStrategy.ts#L15)
 
 The name of the header to look for when performing header based authentication. Default value is `Authorization`.
 
@@ -52,7 +52,7 @@ The name of the header to look for when performing header based authentication.
 
 > **headerScheme**: `string` = `"basic"`
 
-Defined in: [src/auth/BasicStrategy.ts:17](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/BasicStrategy.ts#L17)
+Defined in: [src/auth/BasicStrategy.ts:17](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/BasicStrategy.ts#L17)
 
 The authorization scheme type when using header based authentication. Default value is `jwt`.
 
@@ -62,7 +62,7 @@ The authorization scheme type when using header based authentication. Default va
 
 > **queryKey**: `string` = `"auth_basic"`
 
-Defined in: [src/auth/BasicStrategy.ts:19](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/BasicStrategy.ts#L19)
+Defined in: [src/auth/BasicStrategy.ts:19](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/BasicStrategy.ts#L19)
 
 The name of the request query parameter to retrieve the token from when using query based authentication. Default value is `auth_basic`.
 
@@ -72,7 +72,7 @@ The name of the request query parameter to retrieve the token from when using qu
 
 > **verify**(`uid`, `secret`): `JWTUser` \| `Promise`\<`JWTUser` \| `undefined`\> \| `undefined`
 
-Defined in: [src/auth/BasicStrategy.ts:27](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/BasicStrategy.ts#L27)
+Defined in: [src/auth/BasicStrategy.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/BasicStrategy.ts#L27)
 
 Override this function to handle asynchronous (non-blocking) verification of the login info.
 
@@ -96,7 +96,7 @@ Override this function to handle asynchronous (non-blocking) verification of the
 
 > **verifySync**(`uid`, `secret`): `JWTUser` \| `undefined`
 
-Defined in: [src/auth/BasicStrategy.ts:31](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/auth/BasicStrategy.ts#L31)
+Defined in: [src/auth/BasicStrategy.ts:31](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/auth/BasicStrategy.ts#L31)
 
 Override this function to handle synchronous (blocking) verification of the login info.
 

package/docs/reference/classes/BulkError.md

@@ -6,7 +6,7 @@
 
 # Class: BulkError
 
-Defined in: [src/BulkError.ts:6](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/BulkError.ts#L6)
+Defined in: [src/BulkError.ts:6](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/BulkError.ts#L6)
 
 An error take that takes an array of other errors.
 
@@ -20,7 +20,7 @@ An error take that takes an array of other errors.
 
 > **new BulkError**(`errs`, `code`, `defaultStatus`, `message?`): `BulkError`
 
-Defined in: [src/BulkError.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/BulkError.ts#L12)
+Defined in: [src/BulkError.ts:12](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/BulkError.ts#L12)
 
 #### Parameters
 
@@ -68,7 +68,7 @@ The unique code of the error.
 
 > `readonly` **errors**: (`Error` \| `null`)[] = `[]`
 
-Defined in: [src/BulkError.ts:10](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/BulkError.ts#L10)
+Defined in: [src/BulkError.ts:10](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/BulkError.ts#L10)
 
 The list of errors that have been thrown.
 

package/docs/reference/classes/ConnectionManager.md

@@ -6,7 +6,7 @@
 
 # Class: ConnectionManager
 
-Defined in: [src/database/ConnectionManager.ts:17](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/ConnectionManager.ts#L17)
+Defined in: [src/database/ConnectionManager.ts:17](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/ConnectionManager.ts#L17)
 
 Provides database connection management.
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz
 
 > **connections**: `Map`\<`string`, `Redis` \| `DataSource` \| [`MongoConnection`](MongoConnection.md)\>
 
-Defined in: [src/database/ConnectionManager.ts:18](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/ConnectionManager.ts#L18)
+Defined in: [src/database/ConnectionManager.ts:18](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/ConnectionManager.ts#L18)
 
 ## Methods
 
@@ -38,7 +38,7 @@ Defined in: [src/database/ConnectionManager.ts:18](https://github.com/rapidrest/
 
 > **connect**(`datastores`, `models`): `Promise`\<`void`\>
 
-Defined in: [src/database/ConnectionManager.ts:60](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/ConnectionManager.ts#L60)
+Defined in: [src/database/ConnectionManager.ts:60](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/ConnectionManager.ts#L60)
 
 Attempts to initiate all database connections as defined in the config.
 
@@ -66,7 +66,7 @@ A map of model names and associated class definitions to establish database conn
 
 > **disconnect**(): `Promise`\<`void`\>
 
-Defined in: [src/database/ConnectionManager.ts:136](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/database/ConnectionManager.ts#L136)
+Defined in: [src/database/ConnectionManager.ts:136](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/database/ConnectionManager.ts#L136)
 
 Attempts to disconnect all active database connections.
 

package/docs/reference/classes/EventListenerManager.md

@@ -6,7 +6,7 @@
 
 # Class: EventListenerManager
 
-Defined in: [src/EventListenerManager.ts:18](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/EventListenerManager.ts#L18)
+Defined in: [src/EventListenerManager.ts:18](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/EventListenerManager.ts#L18)
 
 The `EventListenerManager` is responsible for managing event handlers and processing of incoming
 events from the configured redis pubsub channels. An event handler is any function that has been
@@ -25,7 +25,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new EventListenerManager**(`objectFactory`, `redis`): `EventListenerManager`
 
-Defined in: [src/EventListenerManager.ts:27](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/EventListenerManager.ts#L27)
+Defined in: [src/EventListenerManager.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/EventListenerManager.ts#L27)
 
 #### Parameters
 
@@ -47,7 +47,7 @@ Defined in: [src/EventListenerManager.ts:27](https://github.com/rapidrest/servic
 
 > **destroy**(): `Promise`\<`void`\>
 
-Defined in: [src/EventListenerManager.ts:77](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/EventListenerManager.ts#L77)
+Defined in: [src/EventListenerManager.ts:77](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/EventListenerManager.ts#L77)
 
 #### Returns
 
@@ -59,7 +59,7 @@ Defined in: [src/EventListenerManager.ts:77](https://github.com/rapidrest/servic
 
 > **init**(): `Promise`\<`void`\>
 
-Defined in: [src/EventListenerManager.ts:33](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/EventListenerManager.ts#L33)
+Defined in: [src/EventListenerManager.ts:33](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/EventListenerManager.ts#L33)
 
 #### Returns
 
@@ -71,7 +71,7 @@ Defined in: [src/EventListenerManager.ts:33](https://github.com/rapidrest/servic
 
 > **register**(`obj`): `void`
 
-Defined in: [src/EventListenerManager.ts:128](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/EventListenerManager.ts#L128)
+Defined in: [src/EventListenerManager.ts:128](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/EventListenerManager.ts#L128)
 
 Registers the given object to be notified of events that arrive.
 

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