@rapidrest/core 1.2.0 → 1.3.0

package/docs/reference/classes/ObjectFactory.md

@@ -6,7 +6,7 @@
 
 # Class: ObjectFactory
 
-Defined in: [src/ObjectFactory.ts:27](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L27)
+Defined in: [src/ObjectFactory.ts:36](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L36)
 
 The `ObjectFactory` is a manager for creating objects based on registered
 class types. This allows for the tracking of multiple instances of objects
@@ -22,7 +22,7 @@ Jean-Philippe Steinmetz
 
 > **new ObjectFactory**(`config?`, `logger?`): `ObjectFactory`
 
-Defined in: [src/ObjectFactory.ts:40](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L40)
+Defined in: [src/ObjectFactory.ts:55](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L55)
 
 #### Parameters
 
@@ -44,7 +44,7 @@ Defined in: [src/ObjectFactory.ts:40](https://github.com/rapidrest/core/blob/0eb
 
 > `readonly` **classes**: `Map`\<`string`, `any`\>
 
-Defined in: [src/ObjectFactory.ts:29](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L29)
+Defined in: [src/ObjectFactory.ts:38](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L38)
 
 A map for string fully qualified class names to their class types.
 
@@ -54,7 +54,7 @@ A map for string fully qualified class names to their class types.
 
 > `protected` **config**: `any`
 
-Defined in: [src/ObjectFactory.ts:32](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L32)
+Defined in: [src/ObjectFactory.ts:41](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L41)
 
 The global application configuration object.
 
@@ -64,7 +64,7 @@ The global application configuration object.
 
 > `readonly` **instances**: `Map`\<`string`, `any`\>
 
-Defined in: [src/ObjectFactory.ts:35](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L35)
+Defined in: [src/ObjectFactory.ts:44](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L44)
 
 A map for the unique name to the intance of a particular class type.
 
@@ -74,7 +74,7 @@ A map for the unique name to the intance of a particular class type.
 
 > `protected` **logger**: `any`
 
-Defined in: [src/ObjectFactory.ts:38](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L38)
+Defined in: [src/ObjectFactory.ts:47](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L47)
 
 The application logging utility.
 
@@ -84,7 +84,7 @@ The application logging utility.
 
 > **clear**(): `void`
 
-Defined in: [src/ObjectFactory.ts:107](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L107)
+Defined in: [src/ObjectFactory.ts:158](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L158)
 
 Deletes all instantiated objects.
 
@@ -98,7 +98,7 @@ Deletes all instantiated objects.
 
 > **clearAll**(): `void`
 
-Defined in: [src/ObjectFactory.ts:114](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L114)
+Defined in: [src/ObjectFactory.ts:166](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L166)
 
 Deletes all instantiated objects and registered class types.
 
@@ -112,7 +112,7 @@ Deletes all instantiated objects and registered class types.
 
 > **destroy**(`objs?`): `Promise`\<`void`\>
 
-Defined in: [src/ObjectFactory.ts:50](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L50)
+Defined in: [src/ObjectFactory.ts:117](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L117)
 
 Destroys the specified objects. If `undefined` is passed in, all objects managed by the factory are destroyed.
 
@@ -132,7 +132,7 @@ Destroys the specified objects. If `undefined` is passed in, all objects managed
 
 > **getInitMethods**(`obj`): `Function`[]
 
-Defined in: [src/ObjectFactory.ts:215](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L215)
+Defined in: [src/ObjectFactory.ts:248](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L248)
 
 Searches an object for one or more functions that implement a `@Init` decorator.
 
@@ -156,7 +156,7 @@ The list of functions that implements the `@Init` decorator if found, otherwise
 
 > **getInstance**\<`T`\>(`nameOrType`): `T` \| `undefined`
 
-Defined in: [src/ObjectFactory.ts:249](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L249)
+Defined in: [src/ObjectFactory.ts:282](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L282)
 
 Returns the object instance with the given unique name. Unique names take the form `<ClassName>:<InstanceName>`.
 It is possible to only specifiy the `<ClassName>`, doing so will automatically look for the `<ClassName>:default`
@@ -188,7 +188,7 @@ The object instance associated with the given name if found, otherwise `undefine
 
 > **initialize**\<`T`\>(`obj`): `T` \| `Promise`\<`T`\>
 
-Defined in: [src/ObjectFactory.ts:123](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L123)
+Defined in: [src/ObjectFactory.ts:175](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L175)
 
 Scans the given object for any properties with the `@Inject` decorator and assigns the correct values.
 
@@ -216,7 +216,7 @@ The object to initialize with injected defaults
 
 > **newInstance**\<`T`\>(`type`, `options?`): `T` \| `Promise`\<`T`\>
 
-Defined in: [src/ObjectFactory.ts:292](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L292)
+Defined in: [src/ObjectFactory.ts:323](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L323)
 
 Creates a new instance of the class specified with the provided unique name or type and constructor arguments. If an existing
 object has already been created with the given name, that instance is returned, otherwise a new instance is created
@@ -253,7 +253,7 @@ The options to use when instantiating the new class object.
 
 > **register**(`clazz`, `fqn?`): `void`
 
-Defined in: [src/ObjectFactory.ts:363](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L363)
+Defined in: [src/ObjectFactory.ts:399](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L399)
 
 Registers the given class type for the provided fully qualified name.
 

package/docs/reference/classes/ObjectUtils.md

@@ -6,7 +6,7 @@
 
 # Class: ObjectUtils
 
-Defined in: [src/ObjectUtils.ts:12](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectUtils.ts#L12)
+Defined in: [src/ObjectUtils.ts:12](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectUtils.ts#L12)
 
 Utility class for working with objects.
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz
 
 > `static` **validate**(`obj`, `clazz?`, `recurse?`): `void`
 
-Defined in: [src/ObjectUtils.ts:21](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectUtils.ts#L21)
+Defined in: [src/ObjectUtils.ts:21](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectUtils.ts#L21)
 
 Performs validation of the given object or array. Validation is performed by scanning the object class for properties
 decorated with `@Validator` and executing the provided validation function.

package/docs/reference/classes/StringUtils.md

@@ -6,7 +6,7 @@
 
 # Class: StringUtils
 
-Defined in: [src/StringUtils.ts:10](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/StringUtils.ts#L10)
+Defined in: [src/StringUtils.ts:10](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/StringUtils.ts#L10)
 
 Utility functions for working with strings.
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz
 
 > `static` **findAndReplace**(`contents`, `variables`): `string`
 
-Defined in: [src/StringUtils.ts:46](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/StringUtils.ts#L46)
+Defined in: [src/StringUtils.ts:46](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/StringUtils.ts#L46)
 
 Performs a search and replace on the provided contents with the map of variable replacements. The contents
 must use Mustache formatted tokens such as `{{toreplace}}`.
@@ -59,7 +59,7 @@ A map of key=>value pairs to search for and replace.
 
 > `static` **getParameters**(`str`): `string`[]
 
-Defined in: [src/StringUtils.ts:18](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/StringUtils.ts#L18)
+Defined in: [src/StringUtils.ts:18](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/StringUtils.ts#L18)
 
 Returns a list of all parameters contained within the string. A parameter is a bracket delimited substring
 (e.g. /my/{key}/with/{id}).
@@ -84,7 +84,7 @@ A list of parameters contained in the provided string.
 
 > `static` **replaceAll**(`str`, `match`, `prefix`): `string`
 
-Defined in: [src/StringUtils.ts:82](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/StringUtils.ts#L82)
+Defined in: [src/StringUtils.ts:87](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/StringUtils.ts#L87)
 
 Replaces all instances of the match regex pattern with the contents of the inner regular expression pattern for
 the given string.
@@ -126,7 +126,7 @@ The fully replaced contents of the string.
 
 > `static` **toCamelCase**(`str`): `string`
 
-Defined in: [src/StringUtils.ts:100](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/StringUtils.ts#L100)
+Defined in: [src/StringUtils.ts:104](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/StringUtils.ts#L104)
 
 Converts the first character in the given string to be lowercase (e.g. myVariable).
 
@@ -150,7 +150,7 @@ The string converted to camelCase.
 
 > `static` **toPascalCase**(`str`): `string`
 
-Defined in: [src/StringUtils.ts:110](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/StringUtils.ts#L110)
+Defined in: [src/StringUtils.ts:114](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/StringUtils.ts#L114)
 
 Converts the first character in the given string to be uppercase (e.g. MyVariable).
 

package/docs/reference/classes/ThreadPool.md

@@ -6,7 +6,7 @@
 
 # Class: ThreadPool
 
-Defined in: [src/threads/ThreadPool.ts:65](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L65)
+Defined in: [src/threads/ThreadPool.ts:65](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadPool.ts#L65)
 
 The `ThreadPool` class provides an interface for managing a pool of execution threads that can be used for parallel
 code execution. `ThreadPool` is a wrapper to the `worker_threads` API to add support for multiple `Worker` instances.
@@ -42,7 +42,7 @@ Jean-Philippe Steinmetz
 
 > **new ThreadPool**(`max?`, `logger?`): `ThreadPool`
 
-Defined in: [src/threads/ThreadPool.ts:101](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L101)
+Defined in: [src/threads/ThreadPool.ts:101](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadPool.ts#L101)
 
 Creates a new `ThreadPool` instance with the specified defaults.
 
@@ -70,7 +70,7 @@ The Winston logger instance to forward all worker thread logs to.
 
 > `readonly` **workers**: `Worker`[]
 
-Defined in: [src/threads/ThreadPool.ts:77](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L77)
+Defined in: [src/threads/ThreadPool.ts:77](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadPool.ts#L77)
 
 The list of active worker threads.
 
@@ -82,7 +82,7 @@ The list of active worker threads.
 
 > **get** **max**(): `number`
 
-Defined in: [src/threads/ThreadPool.ts:84](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L84)
+Defined in: [src/threads/ThreadPool.ts:84](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadPool.ts#L84)
 
 The maximum number of threads that can be created by the pool.
 
@@ -98,7 +98,7 @@ The maximum number of threads that can be created by the pool.
 
 > **get** **size**(): `number`
 
-Defined in: [src/threads/ThreadPool.ts:91](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L91)
+Defined in: [src/threads/ThreadPool.ts:91](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadPool.ts#L91)
 
 The number of active threads in the pool.
 
@@ -112,7 +112,7 @@ The number of active threads in the pool.
 
 > **on**(`type`, `func`): `void`
 
-Defined in: [src/threads/ThreadPool.ts:254](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L254)
+Defined in: [src/threads/ThreadPool.ts:255](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadPool.ts#L255)
 
 Registers a new callback function to be notified when the given event type is fired.
 
@@ -140,7 +140,7 @@ The callback function to register.
 
 > **send**(`msg`): `void`
 
-Defined in: [src/threads/ThreadPool.ts:267](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L267)
+Defined in: [src/threads/ThreadPool.ts:268](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadPool.ts#L268)
 
 Sends the provided message to the next available worker thread. Messages are sent in a round-robin order.
 
@@ -162,7 +162,7 @@ The message to send the next available worker thread.
 
 > **sendAll**(`msg`): `void`
 
-Defined in: [src/threads/ThreadPool.ts:282](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L282)
+Defined in: [src/threads/ThreadPool.ts:289](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadPool.ts#L289)
 
 Sends the provided message to all worker threads in the pool.
 
@@ -184,7 +184,7 @@ The message to send to all workers.
 
 > **sendTo**(`id`, `msg`): `void`
 
-Defined in: [src/threads/ThreadPool.ts:293](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L293)
+Defined in: [src/threads/ThreadPool.ts:300](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadPool.ts#L300)
 
 Sends the provided message to the worker thread with the specified id.
 
@@ -212,7 +212,7 @@ The message to send the next available worker thread.
 
 > **start**(`options?`, `num?`): `Promise`\<`void`\>
 
-Defined in: [src/threads/ThreadPool.ts:180](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L180)
+Defined in: [src/threads/ThreadPool.ts:181](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadPool.ts#L181)
 
 Initializes the thread pool with the initial worker threads and begins execution.
 
@@ -240,7 +240,7 @@ The number of initial threads to create, cannot be greater than max. Default is
 
 > **stop**(): `Promise`\<`void`\>
 
-Defined in: [src/threads/ThreadPool.ts:227](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L227)
+Defined in: [src/threads/ThreadPool.ts:228](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadPool.ts#L228)
 
 Stops all running thread executions.
 

package/docs/reference/classes/ThreadWorker.md

@@ -6,7 +6,7 @@
 
 # Abstract Class: ThreadWorker
 
-Defined in: [src/threads/ThreadWorker.ts:29](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L29)
+Defined in: [src/threads/ThreadWorker.ts:29](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L29)
 
 Provides a simple abstract interface for creating thread workers when using the `ThreadPool` system.
 
@@ -20,7 +20,7 @@ Jean-Philippe Steinmetz
 
 > **new ThreadWorker**(`logger`): `ThreadWorker`
 
-Defined in: [src/threads/ThreadWorker.ts:32](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L32)
+Defined in: [src/threads/ThreadWorker.ts:32](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L32)
 
 #### Parameters
 
@@ -38,7 +38,7 @@ Defined in: [src/threads/ThreadWorker.ts:32](https://github.com/rapidrest/core/b
 
 > `protected` **logger**: `any`
 
-Defined in: [src/threads/ThreadWorker.ts:30](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L30)
+Defined in: [src/threads/ThreadWorker.ts:30](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L30)
 
 ## Methods
 
@@ -46,7 +46,7 @@ Defined in: [src/threads/ThreadWorker.ts:30](https://github.com/rapidrest/core/b
 
 > `abstract` **onMessage**(`msg`): `void` \| `Promise`\<`void`\>
 
-Defined in: [src/threads/ThreadWorker.ts:41](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L41)
+Defined in: [src/threads/ThreadWorker.ts:41](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L41)
 
 Callback function when a message is received from the thread pool manager.
 
@@ -68,7 +68,7 @@ The message that was received.
 
 > `abstract` **start**(): `void` \| `Promise`\<`void`\>
 
-Defined in: [src/threads/ThreadWorker.ts:46](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L46)
+Defined in: [src/threads/ThreadWorker.ts:46](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L46)
 
 Starts execution of the thread worker.
 
@@ -82,7 +82,7 @@ Starts execution of the thread worker.
 
 > `abstract` **stop**(): `void` \| `Promise`\<`void`\>
 
-Defined in: [src/threads/ThreadWorker.ts:51](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L51)
+Defined in: [src/threads/ThreadWorker.ts:51](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L51)
 
 Stops execution of all work and shuts down the thread worker.
 

package/docs/reference/classes/UserUtils.md

@@ -6,7 +6,7 @@
 
 # Class: UserUtils
 
-Defined in: [src/UserUtils.ts:16](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/UserUtils.ts#L16)
+Defined in: [src/UserUtils.ts:16](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/UserUtils.ts#L16)
 
 Utilities for working with authenticated user objects. An user object is expected to have the following
 properties.
@@ -36,7 +36,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > `static` **getExternalId**(`user`, `type`): `string` \| `undefined`
 
-Defined in: [src/UserUtils.ts:60](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/UserUtils.ts#L60)
+Defined in: [src/UserUtils.ts:60](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/UserUtils.ts#L60)
 
 Returns the unique identifier of the specified type associated with the given user.
 
@@ -66,7 +66,7 @@ The unique id of the external provider for the given type if found, otherwise `u
 
 > `static` **hasOrganization**(`user`, `organizationUid`): `boolean`
 
-Defined in: [src/UserUtils.ts:22](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/UserUtils.ts#L22)
+Defined in: [src/UserUtils.ts:22](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/UserUtils.ts#L22)
 
 Returns `true` if the given user object is a member of the organization with the specified uid, otherwise returns `false`.
 
@@ -94,7 +94,7 @@ The universally unique identifier of the persona to search for.
 
 > `static` **hasOrganizations**(`user`, `organizationUids?`): `boolean`
 
-Defined in: [src/UserUtils.ts:39](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/UserUtils.ts#L39)
+Defined in: [src/UserUtils.ts:39](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/UserUtils.ts#L39)
 
 Returns `true` if the given user object contains is a member of an organization matching one of the uids in the specified list, otherwise returns `false`.
 
@@ -122,7 +122,7 @@ The list of universally unique identifiers to search for.
 
 > `static` **hasRole**(`user`, `role?`, `orgUid?`): `boolean`
 
-Defined in: [src/UserUtils.ts:82](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/UserUtils.ts#L82)
+Defined in: [src/UserUtils.ts:82](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/UserUtils.ts#L82)
 
 Returns `true` if the given user object has a role with the specified name, otherwise returns `false`.
 
@@ -156,7 +156,7 @@ The unique identifier of an organization whose role will be verified.
 
 > `static` **hasRoles**(`user`, `roles?`, `orgUid?`): `boolean`
 
-Defined in: [src/UserUtils.ts:107](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/UserUtils.ts#L107)
+Defined in: [src/UserUtils.ts:107](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/UserUtils.ts#L107)
 
 Returns `true` if the given user object has at least one role from the specified list of names, otherwise returns `false`.
 

package/docs/reference/classes/ValidationUtils.md

@@ -6,7 +6,7 @@
 
 # Class: ValidationUtils
 
-Defined in: [src/ValidationUtils.ts:14](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L14)
+Defined in: [src/ValidationUtils.ts:14](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L14)
 
 A collection of validation functions to use with the `@Validator()` decorator.
 
@@ -26,7 +26,7 @@ A collection of validation functions to use with the `@Validator()` decorator.
 
 > `static` **check**(`val`, `func`): `any`
 
-Defined in: [src/ValidationUtils.ts:23](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L23)
+Defined in: [src/ValidationUtils.ts:23](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L23)
 
 A simple wrapper that calls the specified boolean validation function with the given value and returns the
 value as a result if the validation function passes. Otherwise throws an error.
@@ -59,7 +59,7 @@ Throws an error if the value fails the boolean validation test.
 
 > `static` **checkDate**(`val`): `string`
 
-Defined in: [src/ValidationUtils.ts:33](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L33)
+Defined in: [src/ValidationUtils.ts:33](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L33)
 
 Validates that the provided string represents a ISO, RFC or UTC date or timestamp.
 
@@ -79,7 +79,7 @@ Validates that the provided string represents a ISO, RFC or UTC date or timestam
 
 > `static` **checkEmail**(`val`): `string`
 
-Defined in: [src/ValidationUtils.ts:43](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L43)
+Defined in: [src/ValidationUtils.ts:43](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L43)
 
 Validates that the provided string represents a valid e-mail address.
 
@@ -99,7 +99,7 @@ Validates that the provided string represents a valid e-mail address.
 
 > `static` **checkEmpty**(`val`): `any`[]
 
-Defined in: [src/ValidationUtils.ts:53](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L53)
+Defined in: [src/ValidationUtils.ts:53](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L53)
 
 Validates that the provided array is not empty.
 
@@ -119,7 +119,7 @@ Validates that the provided array is not empty.
 
 > `static` **checkIP**(`val`): `string`
 
-Defined in: [src/ValidationUtils.ts:63](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L63)
+Defined in: [src/ValidationUtils.ts:63](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L63)
 
 Validates that the provided string is a valid IP address.
 
@@ -139,7 +139,7 @@ Validates that the provided string is a valid IP address.
 
 > `static` **checkJSON**(`val`): `string`
 
-Defined in: [src/ValidationUtils.ts:73](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L73)
+Defined in: [src/ValidationUtils.ts:73](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L73)
 
 Validates that the provided string is valid JSON (note: uses `JSON.parse`).
 
@@ -159,7 +159,7 @@ Validates that the provided string is valid JSON (note: uses `JSON.parse`).
 
 > `static` **checkName**(`val`): `string`
 
-Defined in: [src/ValidationUtils.ts:83](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L83)
+Defined in: [src/ValidationUtils.ts:83](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L83)
 
 Validates that the provided string matches the regexp pattern /[a-zA-Z0-9_\-\.@:\+]+/.
 
@@ -179,7 +179,7 @@ Validates that the provided string matches the regexp pattern /[a-zA-Z0-9_\-\.@:
 
 > `static` **checkNull**(`val`): `any`
 
-Defined in: [src/ValidationUtils.ts:93](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L93)
+Defined in: [src/ValidationUtils.ts:93](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L93)
 
 Validates that the provided object is not null or empty.
 
@@ -199,7 +199,7 @@ Validates that the provided object is not null or empty.
 
 > `static` **checkPhone**(`val`): `string`
 
-Defined in: [src/ValidationUtils.ts:103](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L103)
+Defined in: [src/ValidationUtils.ts:103](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L103)
 
 Validates that the provided string represents a valid phone number.
 
@@ -219,7 +219,7 @@ Validates that the provided string represents a valid phone number.
 
 > `static` **checkSemVer**(`val`): `string`
 
-Defined in: [src/ValidationUtils.ts:113](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L113)
+Defined in: [src/ValidationUtils.ts:113](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L113)
 
 Validates that the provided string represents a semantic version.
 
@@ -239,7 +239,7 @@ Validates that the provided string represents a semantic version.
 
 > `static` **checkURL**(`val`): `string`
 
-Defined in: [src/ValidationUtils.ts:123](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L123)
+Defined in: [src/ValidationUtils.ts:123](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L123)
 
 Validates that the provided string is a valid URL.
 
@@ -259,7 +259,7 @@ Validates that the provided string is a valid URL.
 
 > `static` **checkUUID**(`val`): `string`
 
-Defined in: [src/ValidationUtils.ts:133](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L133)
+Defined in: [src/ValidationUtils.ts:133](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L133)
 
 Validates that the provided string is a valid UUID.
 
@@ -279,7 +279,7 @@ Validates that the provided string is a valid UUID.
 
 > `static` **checkVersion**(`val`): `number`
 
-Defined in: [src/ValidationUtils.ts:143](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L143)
+Defined in: [src/ValidationUtils.ts:143](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L143)
 
 Validates that the provided value is an entity `version` number (e.g. `value > 0`).
 

package/docs/reference/enumerations/AlertPriority.md

@@ -6,7 +6,7 @@
 
 # Enumeration: AlertPriority
 
-Defined in: [src/AlertUtils.ts:24](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L24)
+Defined in: [src/AlertUtils.ts:24](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L24)
 
 Describes the level of priority for a given alert and an importance for triaging the problem.
 
@@ -16,7 +16,7 @@ Describes the level of priority for a given alert and an importance for triaging
 
 > **Critical**: `"P1"`
 
-Defined in: [src/AlertUtils.ts:26](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L26)
+Defined in: [src/AlertUtils.ts:26](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L26)
 
 Describes an alert that affects critical operating functionality or infrastructure.
 
@@ -26,7 +26,7 @@ Describes an alert that affects critical operating functionality or infrastructu
 
 > **Important**: `"P3"`
 
-Defined in: [src/AlertUtils.ts:30](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L30)
+Defined in: [src/AlertUtils.ts:30](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L30)
 
 Describes an alert that affects basic systems that may create a poor end-user experience.
 
@@ -36,7 +36,7 @@ Describes an alert that affects basic systems that may create a poor end-user ex
 
 > **Notice**: `"P5"`
 
-Defined in: [src/AlertUtils.ts:34](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L34)
+Defined in: [src/AlertUtils.ts:34](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L34)
 
 Describes an alert that has no material affect on end-user experience and no potential for escalation.
 
@@ -46,7 +46,7 @@ Describes an alert that has no material affect on end-user experience and no pot
 
 > **Severe**: `"P2"`
 
-Defined in: [src/AlertUtils.ts:28](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L28)
+Defined in: [src/AlertUtils.ts:28](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L28)
 
 Describes an alert that affects key systems that have great impact on end-user experiences.
 
@@ -56,6 +56,6 @@ Describes an alert that affects key systems that have great impact on end-user e
 
 > **Warning**: `"P4"`
 
-Defined in: [src/AlertUtils.ts:32](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L32)
+Defined in: [src/AlertUtils.ts:32](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L32)
 
 Describes an alert that has no material affect on the end-user experience but with potential to escalate.

package/docs/reference/enumerations/JWTUtilsCompressionMethods.md

@@ -6,7 +6,7 @@
 
 # Enumeration: JWTUtilsCompressionMethods
 
-Defined in: [src/JWTUtils.ts:55](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L55)
+Defined in: [src/JWTUtils.ts:55](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L55)
 
 Describes the different types of support compression methods for JWT payloads.
 
@@ -16,6 +16,6 @@ Describes the different types of support compression methods for JWT payloads.
 
 > **ZLIB**: `"zlib"`
 
-Defined in: [src/JWTUtils.ts:57](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L57)
+Defined in: [src/JWTUtils.ts:57](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L57)
 
 Uses the zlib compression method.

package/docs/reference/enumerations/WorkerMessageType.md

@@ -6,7 +6,7 @@
 
 # Enumeration: WorkerMessageType
 
-Defined in: [src/threads/ThreadWorker.ts:7](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L7)
+Defined in: [src/threads/ThreadWorker.ts:7](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L7)
 
 Describes the types of messages passed between the parent thread pool manager and a worker thread.
 
@@ -16,7 +16,7 @@ Describes the types of messages passed between the parent thread pool manager an
 
 > **ERROR**: `"_WorkerError"`
 
-Defined in: [src/threads/ThreadWorker.ts:8](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L8)
+Defined in: [src/threads/ThreadWorker.ts:8](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L8)
 
 ***
 
@@ -24,7 +24,7 @@ Defined in: [src/threads/ThreadWorker.ts:8](https://github.com/rapidrest/core/bl
 
 > **LOG**: `"_WorkerLog"`
 
-Defined in: [src/threads/ThreadWorker.ts:9](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L9)
+Defined in: [src/threads/ThreadWorker.ts:9](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L9)
 
 ***
 
@@ -32,7 +32,7 @@ Defined in: [src/threads/ThreadWorker.ts:9](https://github.com/rapidrest/core/bl
 
 > **ONLINE**: `"_WorkerOnline"`
 
-Defined in: [src/threads/ThreadWorker.ts:10](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L10)
+Defined in: [src/threads/ThreadWorker.ts:10](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L10)
 
 ***
 
@@ -40,4 +40,4 @@ Defined in: [src/threads/ThreadWorker.ts:10](https://github.com/rapidrest/core/b
 
 > **STOP**: `"_StopWorker"`
 
-Defined in: [src/threads/ThreadWorker.ts:11](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L11)
+Defined in: [src/threads/ThreadWorker.ts:11](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L11)