@rapidrest/core 1.1.0 → 1.2.0

package/docs/reference/classes/StringUtils.md

@@ -6,7 +6,7 @@
 
 # Class: StringUtils
 
-Defined in: [src/StringUtils.ts:10](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/StringUtils.ts#L10)
+Defined in: [src/StringUtils.ts:10](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/StringUtils.ts#L46)
+Defined in: [src/StringUtils.ts:46](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/StringUtils.ts#L18)
+Defined in: [src/StringUtils.ts:18](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/StringUtils.ts#L82)
+Defined in: [src/StringUtils.ts:82](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/StringUtils.ts#L82)
 
 Replaces all instances of the match regex pattern with the contents of the inner regular expression pattern for
 the given string.
@@ -104,9 +104,9 @@ The string to perform replacement on.
 
 ##### match
 
-The regular expression pattern to match containing an outer and inner pattern.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The regular expression pattern to match containing an outer and inner pattern.
 
 ##### prefix
 
@@ -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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/StringUtils.ts#L100)
+Defined in: [src/StringUtils.ts:100](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/StringUtils.ts#L100)
 
 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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/StringUtils.ts#L110)
+Defined in: [src/StringUtils.ts:110](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/StringUtils.ts#L110)
 
 Converts the first character in the given string to be uppercase (e.g. MyVariable).
 

package/docs/reference/classes/ThreadPool.md

@@ -6,30 +6,30 @@
 
 # Class: ThreadPool
 
-Defined in: [src/threads/ThreadPool.ts:62](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L62)
+Defined in: [src/threads/ThreadPool.ts:65](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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.
+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.
 By default, the pool will create *n* workers corresponding to the number of CPUs (physical + virtual) on the system.
 
 There are two ways to start worker threads with the pool.
 
-The first way is to set the `entry` option when calling the `start()` function. This will create a instance of the
-`worker_threads` APIs `Worker` class with the specified file as the entry point. Note that this file must be of
-type JavaScript (`.js` extension) as the underlying system does not support loading TypeScript. If the `args` option
+The first way is to set the `entry` option when calling the `start()` function. This will create a instance of the
+`worker_threads` APIs `Worker` class with the specified file as the entry point. Note that this file must be of
+type JavaScript (`.js` extension) as the underlying system does not support loading TypeScript. If the `args` option
 is set, the value will be passed in as the `workerData` to the entry file.
 
-The second way to start a worker thread is by setting the `worker` argument when calling the `start()` function. The
-specified `worker` file must contain a `default` export. The `default` export must be a class definition which
-extends the `ThreadWorker` abstract class interface. The file can be either JavaScript or TypeScript. When using
-this method the `start()` function will return only when all worker instances in each thread of the pool has
-successfully returned from its `start()` function. When the `args` option is set, the value(s) will be passed in to
+The second way to start a worker thread is by setting the `worker` argument when calling the `start()` function. The
+specified `worker` file must contain a `default` export. The `default` export must be a class definition which
+extends the `ThreadWorker` abstract class interface. The file can be either JavaScript or TypeScript. When using
+this method the `start()` function will return only when all worker instances in each thread of the pool has
+successfully returned from its `start()` function. When the `args` option is set, the value(s) will be passed in to
 the constructor on instantiation by the thread executor.
 
-When the `restartOnExit` option is specified, the pool will automatically recreate and start a worker thread on
+When the `restartOnExit` option is specified, the pool will automatically recreate and start a worker thread on
 the `exit event`.
 
-This class exposes worker messages via the `on()` callback handler function. Registering a callback handler via
+This class exposes worker messages via the `on()` callback handler function. Registering a callback handler via
 `on()` will propogate all messages from all underlying threads in the pool.
 
 ## Author
@@ -40,15 +40,15 @@ Jean-Philippe Steinmetz
 
 ### Constructor
 
-> **new ThreadPool**(`max`, `logger?`): `ThreadPool`
+> **new ThreadPool**(`max?`, `logger?`): `ThreadPool`
 
-Defined in: [src/threads/ThreadPool.ts:98](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L98)
+Defined in: [src/threads/ThreadPool.ts:101](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L101)
 
 Creates a new `ThreadPool` instance with the specified defaults.
 
 #### Parameters
 
-##### max
+##### max?
 
 `number` = `0`
 
@@ -70,7 +70,7 @@ The Winston logger instance to forward all worker thread logs to.
 
 > `readonly` **workers**: `Worker`[]
 
-Defined in: [src/threads/ThreadPool.ts:74](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L74)
+Defined in: [src/threads/ThreadPool.ts:77](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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:81](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L81)
+Defined in: [src/threads/ThreadPool.ts:84](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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:88](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L88)
+Defined in: [src/threads/ThreadPool.ts:91](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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:251](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L251)
+Defined in: [src/threads/ThreadPool.ts:254](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L254)
 
 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:264](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L264)
+Defined in: [src/threads/ThreadPool.ts:267](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L267)
 
 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:279](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L279)
+Defined in: [src/threads/ThreadPool.ts:282](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L282)
 
 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:290](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L290)
+Defined in: [src/threads/ThreadPool.ts:293](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L293)
 
 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:177](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L177)
+Defined in: [src/threads/ThreadPool.ts:180](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L180)
 
 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:224](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L224)
+Defined in: [src/threads/ThreadPool.ts:227](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L227)
 
 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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L29)
+Defined in: [src/threads/ThreadWorker.ts:29](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L32)
+Defined in: [src/threads/ThreadWorker.ts:32](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L30)
+Defined in: [src/threads/ThreadWorker.ts:30](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L41)
+Defined in: [src/threads/ThreadWorker.ts:41](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L46)
+Defined in: [src/threads/ThreadWorker.ts:46](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L51)
+Defined in: [src/threads/ThreadWorker.ts:51](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L51)
 
 Stops execution of all work and shuts down the thread worker.
 

package/docs/reference/classes/UserUtils.md

@@ -6,14 +6,14 @@
 
 # Class: UserUtils
 
-Defined in: [src/UserUtils.ts:16](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/UserUtils.ts#L16)
+Defined in: [src/UserUtils.ts:16](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/UserUtils.ts#L16)
 
-Utilities for working with authenticated user objects. An user object is expected to have the following
+Utilities for working with authenticated user objects. An user object is expected to have the following
 properties.
 
-* `uid` - Universally unique identifier for the user
-* `email` - Unique e-mail address for the user
-* `roles` - A list of unique names indicating the permissions of the user.
+* `uid` - Universally unique identifier for the user
+* `email` - Unique e-mail address for the user
+* `roles` - A list of unique names indicating the permissions of the user.
 * `verified` - Indicates if the user's e-mail address has been verified.
 
 ## Author
@@ -36,7 +36,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > `static` **getExternalId**(`user`, `type`): `string` \| `undefined`
 
-Defined in: [src/UserUtils.ts:96](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/UserUtils.ts#L96)
+Defined in: [src/UserUtils.ts:60](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/UserUtils.ts#L22)
+Defined in: [src/UserUtils.ts:22](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/UserUtils.ts#L39)
+Defined in: [src/UserUtils.ts:39](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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`.
 
@@ -118,65 +118,11 @@ The list of universally unique identifiers to search for.
 
 ***
 
-### hasPersona()
-
-> `static` **hasPersona**(`user`, `personaUid?`): `boolean`
-
-Defined in: [src/UserUtils.ts:58](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/UserUtils.ts#L58)
-
-Returns `true` if the given user object contains a `Persona` object with the specified uid, otherwise returns `false`.
-
-#### Parameters
-
-##### user
-
-`any`
-
-The user object to inspect.
-
-##### personaUid?
-
-`string`
-
-The universally unique identifier of the persona to search for.
-
-#### Returns
-
-`boolean`
-
-***
-
-### hasPersonas()
-
-> `static` **hasPersonas**(`user`, `personaUids?`): `boolean`
-
-Defined in: [src/UserUtils.ts:75](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/UserUtils.ts#L75)
-
-Returns `true` if the given user object contains a `Persona` object matching one of the uids in the specified list, otherwise returns `false`.
-
-#### Parameters
-
-##### user
-
-`any`
-
-The user object to inspect.
-
-##### personaUids?
-
-`string`[]
-
-#### Returns
-
-`boolean`
-
-***
-
 ### hasRole()
 
 > `static` **hasRole**(`user`, `role?`, `orgUid?`): `boolean`
 
-Defined in: [src/UserUtils.ts:118](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/UserUtils.ts#L118)
+Defined in: [src/UserUtils.ts:82](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/UserUtils.ts#L82)
 
 Returns `true` if the given user object has a role with the specified name, otherwise returns `false`.
 
@@ -210,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:143](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/UserUtils.ts#L143)
+Defined in: [src/UserUtils.ts:107](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L14)
+Defined in: [src/ValidationUtils.ts:14](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L23)
+Defined in: [src/ValidationUtils.ts:23](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L33)
+Defined in: [src/ValidationUtils.ts:33](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L43)
+Defined in: [src/ValidationUtils.ts:43](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L53)
+Defined in: [src/ValidationUtils.ts:53](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L63)
+Defined in: [src/ValidationUtils.ts:63](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L73)
+Defined in: [src/ValidationUtils.ts:73](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L83)
+Defined in: [src/ValidationUtils.ts:83](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L93)
+Defined in: [src/ValidationUtils.ts:93](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L103)
+Defined in: [src/ValidationUtils.ts:103](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L113)
+Defined in: [src/ValidationUtils.ts:113](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L123)
+Defined in: [src/ValidationUtils.ts:123](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L133)
+Defined in: [src/ValidationUtils.ts:133](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L143)
+Defined in: [src/ValidationUtils.ts:143](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L24)
+Defined in: [src/AlertUtils.ts:24](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L26)
+Defined in: [src/AlertUtils.ts:26](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L30)
+Defined in: [src/AlertUtils.ts:30](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L34)
+Defined in: [src/AlertUtils.ts:34](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L28)
+Defined in: [src/AlertUtils.ts:28](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L32)
+Defined in: [src/AlertUtils.ts:32](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L55)
+Defined in: [src/JWTUtils.ts:55](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L57)
+Defined in: [src/JWTUtils.ts:57](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L7)
+Defined in: [src/threads/ThreadWorker.ts:7](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L8)
+Defined in: [src/threads/ThreadWorker.ts:8](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L9)
+Defined in: [src/threads/ThreadWorker.ts:9](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L10)
+Defined in: [src/threads/ThreadWorker.ts:10](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L11)
+Defined in: [src/threads/ThreadWorker.ts:11](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L11)

package/docs/reference/functions/sleep.md

@@ -6,15 +6,15 @@
 
 # Function: sleep()
 
-> **sleep**(`ms`): `Promise`\<`void`\>
+> **sleep**(`ms?`): `Promise`\<`void`\>
 
-Defined in: [src/sleep.ts:8](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/sleep.ts#L8)
+Defined in: [src/sleep.ts:8](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/sleep.ts#L8)
 
 Starts a timer to suspend execution for a given number of milliseconds.
 
 ## Parameters
 
-### ms
+### ms?
 
 `number` = `1`