@rapidrest/core 1.3.0 → 1.3.1

package/docs/reference/classes/ValidationUtils.md

@@ -6,7 +6,7 @@
 
 # Class: ValidationUtils
 
-Defined in: [src/ValidationUtils.ts:14](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L14)
+Defined in: [src/ValidationUtils.ts:14](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L23)
+Defined in: [src/ValidationUtils.ts:23](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L33)
+Defined in: [src/ValidationUtils.ts:33](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L43)
+Defined in: [src/ValidationUtils.ts:43](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L53)
+Defined in: [src/ValidationUtils.ts:53](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L63)
+Defined in: [src/ValidationUtils.ts:63](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L73)
+Defined in: [src/ValidationUtils.ts:73](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L83)
+Defined in: [src/ValidationUtils.ts:83](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L93)
+Defined in: [src/ValidationUtils.ts:93](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L103)
+Defined in: [src/ValidationUtils.ts:103](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L113)
+Defined in: [src/ValidationUtils.ts:113](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L123)
+Defined in: [src/ValidationUtils.ts:123](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L133)
+Defined in: [src/ValidationUtils.ts:133](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/ValidationUtils.ts#L143)
+Defined in: [src/ValidationUtils.ts:143](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L24)
+Defined in: [src/AlertUtils.ts:24](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L26)
+Defined in: [src/AlertUtils.ts:26](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L30)
+Defined in: [src/AlertUtils.ts:30](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L34)
+Defined in: [src/AlertUtils.ts:34](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L28)
+Defined in: [src/AlertUtils.ts:28](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L32)
+Defined in: [src/AlertUtils.ts:32](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L55)
+Defined in: [src/JWTUtils.ts:55](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L57)
+Defined in: [src/JWTUtils.ts:57](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L7)
+Defined in: [src/threads/ThreadWorker.ts:7](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L8)
+Defined in: [src/threads/ThreadWorker.ts:8](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L9)
+Defined in: [src/threads/ThreadWorker.ts:9](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L10)
+Defined in: [src/threads/ThreadWorker.ts:10](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L11)
+Defined in: [src/threads/ThreadWorker.ts:11](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadWorker.ts#L11)

package/docs/reference/functions/sleep.md

@@ -8,7 +8,7 @@
 
 > **sleep**(`ms?`): `Promise`\<`void`\>
 
-Defined in: [src/sleep.ts:8](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/sleep.ts#L8)
+Defined in: [src/sleep.ts:8](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/sleep.ts#L8)
 
 Starts a timer to suspend execution for a given number of milliseconds.
 

package/docs/reference/interfaces/Alert.md

@@ -6,7 +6,7 @@
 
 # Interface: Alert
 
-Defined in: [src/AlertUtils.ts:40](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L40)
+Defined in: [src/AlertUtils.ts:40](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L40)
 
 Describes a single system failure or other similar critical event that requires immediate attention.
 
@@ -16,7 +16,7 @@ Describes a single system failure or other similar critical event that requires
 
 > **alias**: `string`
 
-Defined in: [src/AlertUtils.ts:42](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L42)
+Defined in: [src/AlertUtils.ts:42](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L42)
 
 The name of the alert that uniquely identifies the report for purposes of de-duplication.
 
@@ -26,7 +26,7 @@ The name of the alert that uniquely identifies the report for purposes of de-dup
 
 > **description**: `string`
 
-Defined in: [src/AlertUtils.ts:44](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L44)
+Defined in: [src/AlertUtils.ts:44](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L44)
 
 The detailed information about the event that has occurred.
 
@@ -36,7 +36,7 @@ The detailed information about the event that has occurred.
 
 > `optional` **details?**: `any`
 
-Defined in: [src/AlertUtils.ts:46](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L46)
+Defined in: [src/AlertUtils.ts:46](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L46)
 
 A key-value map of custom information about the alert.
 
@@ -46,7 +46,7 @@ A key-value map of custom information about the alert.
 
 > `optional` **entity?**: `string`
 
-Defined in: [src/AlertUtils.ts:48](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L48)
+Defined in: [src/AlertUtils.ts:48](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L48)
 
 Used to specify a category or problem domain for filtering.
 
@@ -56,7 +56,7 @@ Used to specify a category or problem domain for filtering.
 
 > **message**: `string`
 
-Defined in: [src/AlertUtils.ts:50](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L50)
+Defined in: [src/AlertUtils.ts:50](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L50)
 
 The basic summary of the alert that describes the event.
 
@@ -66,7 +66,7 @@ The basic summary of the alert that describes the event.
 
 > `optional` **note?**: `string`
 
-Defined in: [src/AlertUtils.ts:52](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L52)
+Defined in: [src/AlertUtils.ts:52](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L52)
 
 Additional detail about the event.
 
@@ -76,7 +76,7 @@ Additional detail about the event.
 
 > **priority**: [`AlertPriority`](../enumerations/AlertPriority.md)
 
-Defined in: [src/AlertUtils.ts:54](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L54)
+Defined in: [src/AlertUtils.ts:54](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L54)
 
 The priority level of the alert.
 
@@ -86,7 +86,7 @@ The priority level of the alert.
 
 > **source**: `string`
 
-Defined in: [src/AlertUtils.ts:56](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L56)
+Defined in: [src/AlertUtils.ts:56](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L56)
 
 The source of the alert. Can be a pod/service name, IP address or other unique identifier.
 
@@ -96,6 +96,6 @@ The source of the alert. Can be a pod/service name, IP address or other unique i
 
 > `optional` **tags?**: `string`[]
 
-Defined in: [src/AlertUtils.ts:58](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L58)
+Defined in: [src/AlertUtils.ts:58](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L58)
 
 A list of unique tags to associate with the event.

package/docs/reference/interfaces/AlertAttachment.md

@@ -6,7 +6,7 @@
 
 # Interface: AlertAttachment
 
-Defined in: [src/AlertUtils.ts:64](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L64)
+Defined in: [src/AlertUtils.ts:64](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L64)
 
 Describes a single attachment that can be added to an alert.
 
@@ -16,7 +16,7 @@ Describes a single attachment that can be added to an alert.
 
 > **contentType**: `string`
 
-Defined in: [src/AlertUtils.ts:66](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L66)
+Defined in: [src/AlertUtils.ts:66](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L66)
 
 The content-type of the attachment.
 
@@ -26,7 +26,7 @@ The content-type of the attachment.
 
 > **data**: `Buffer`\<`ArrayBufferLike`\> \| `ReadStream`
 
-Defined in: [src/AlertUtils.ts:68](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L68)
+Defined in: [src/AlertUtils.ts:68](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L68)
 
 The contents of the attachment.
 
@@ -36,7 +36,7 @@ The contents of the attachment.
 
 > **filename**: `string`
 
-Defined in: [src/AlertUtils.ts:70](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L70)
+Defined in: [src/AlertUtils.ts:70](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L70)
 
 The name of the attachment.
 
@@ -46,6 +46,6 @@ The name of the attachment.
 
 > `optional` **size?**: `number`
 
-Defined in: [src/AlertUtils.ts:72](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L72)
+Defined in: [src/AlertUtils.ts:72](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L72)
 
 The size of the attachment.

package/docs/reference/interfaces/AlertClose.md

@@ -6,7 +6,7 @@
 
 # Interface: AlertClose
 
-Defined in: [src/AlertUtils.ts:78](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L78)
+Defined in: [src/AlertUtils.ts:78](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L78)
 
 Describes a request to close an alert.
 
@@ -16,7 +16,7 @@ Describes a request to close an alert.
 
 > `optional` **note?**: `string`
 
-Defined in: [src/AlertUtils.ts:82](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L82)
+Defined in: [src/AlertUtils.ts:82](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L82)
 
 Additional alert note to add.
 
@@ -26,6 +26,6 @@ Additional alert note to add.
 
 > `optional` **source?**: `string`
 
-Defined in: [src/AlertUtils.ts:80](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L80)
+Defined in: [src/AlertUtils.ts:80](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L80)
 
 Display name of the request source.

package/docs/reference/interfaces/AlertUtilsAttachmentOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: AlertUtilsAttachmentOptions
 
-Defined in: [src/AlertUtils.ts:100](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L100)
+Defined in: [src/AlertUtils.ts:100](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L100)
 
 Describes the alert attachment options to use when creating an alert.
 
@@ -16,7 +16,7 @@ Describes the alert attachment options to use when creating an alert.
 
 > **files**: [`AlertAttachment`](AlertAttachment.md)[]
 
-Defined in: [src/AlertUtils.ts:102](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L102)
+Defined in: [src/AlertUtils.ts:102](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L102)
 
 The attachment files to upload with the alert.
 
@@ -26,7 +26,7 @@ The attachment files to upload with the alert.
 
 > `optional` **indexFile?**: `string`
 
-Defined in: [src/AlertUtils.ts:104](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L104)
+Defined in: [src/AlertUtils.ts:104](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L104)
 
 The name of the index file when the attachment is a zip file.
 
@@ -36,7 +36,7 @@ The name of the index file when the attachment is a zip file.
 
 > `optional` **zip?**: `boolean`
 
-Defined in: [src/AlertUtils.ts:109](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L109)
+Defined in: [src/AlertUtils.ts:109](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L109)
 
 Set to `true` to to package all files into a single zip before being uploaded, otherwise set to `false` to
 upload each file individually.

package/docs/reference/interfaces/AlertUtilsOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: AlertUtilsOptions
 
-Defined in: [src/AlertUtils.ts:88](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L88)
+Defined in: [src/AlertUtils.ts:88](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L88)
 
 The set of configuration options to pass to AlertUtils when creating an instance.
 
@@ -16,7 +16,7 @@ The set of configuration options to pass to AlertUtils when creating an instance
 
 > **auth**: `string`
 
-Defined in: [src/AlertUtils.ts:90](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L90)
+Defined in: [src/AlertUtils.ts:90](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L90)
 
 The value of the Authorization header to apply to all outgoing HTTP requests.
 
@@ -26,7 +26,7 @@ The value of the Authorization header to apply to all outgoing HTTP requests.
 
 > `optional` **logger?**: `any`
 
-Defined in: [src/AlertUtils.ts:94](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L94)
+Defined in: [src/AlertUtils.ts:94](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L94)
 
 The logging utility to use.
 
@@ -36,6 +36,6 @@ The logging utility to use.
 
 > **serviceUrl**: `string`
 
-Defined in: [src/AlertUtils.ts:92](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/AlertUtils.ts#L92)
+Defined in: [src/AlertUtils.ts:92](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L92)
 
 The full url of the REST API service that alerts will be sent to.

package/docs/reference/interfaces/InstanceOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: InstanceOptions
 
-Defined in: [src/ObjectFactory.ts:11](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L11)
+Defined in: [src/ObjectFactory.ts:11](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L11)
 
 The set of options to use when creating new instances of objects.
 
@@ -16,7 +16,7 @@ The set of options to use when creating new instances of objects.
 
 > `optional` **args?**: `any`[]
 
-Defined in: [src/ObjectFactory.ts:13](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L13)
+Defined in: [src/ObjectFactory.ts:13](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L13)
 
 The list of arguments to pass to the class constructor.
 
@@ -26,7 +26,7 @@ The list of arguments to pass to the class constructor.
 
 > `optional` **initialize?**: `boolean`
 
-Defined in: [src/ObjectFactory.ts:17](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L17)
+Defined in: [src/ObjectFactory.ts:17](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L17)
 
 Set to `true` to perform initialization of the object after creation, otherwise set to `false`. Default is `true`.
 
@@ -36,6 +36,6 @@ Set to `true` to perform initialization of the object after creation, otherwise
 
 > `optional` **name?**: `string`
 
-Defined in: [src/ObjectFactory.ts:15](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/ObjectFactory.ts#L15)
+Defined in: [src/ObjectFactory.ts:15](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L15)
 
 The unique name of the object instance.

package/docs/reference/interfaces/JWTPayload.md

@@ -6,7 +6,7 @@
 
 # Interface: JWTPayload
 
-Defined in: [src/JWTUtils.ts:38](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L38)
+Defined in: [src/JWTUtils.ts:38](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L38)
 
 Describes the payload data structure of signed JWT tokens.
 
@@ -36,7 +36,7 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:115
 
 > `optional` **compression?**: `"zlib"`
 
-Defined in: [src/JWTUtils.ts:40](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L40)
+Defined in: [src/JWTUtils.ts:40](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L40)
 
 Indicates if the payload profile has been compressed and with what method.
 
@@ -46,7 +46,7 @@ Indicates if the payload profile has been compressed and with what method.
 
 > `optional` **encryption?**: `boolean`
 
-Defined in: [src/JWTUtils.ts:43](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L43)
+Defined in: [src/JWTUtils.ts:43](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L43)
 
 Indicates if the payload profile has been encrypted.
 
@@ -116,7 +116,7 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:117
 
 > **profile**: `string` \| [`JWTUser`](JWTUser.md)
 
-Defined in: [src/JWTUtils.ts:46](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L46)
+Defined in: [src/JWTUtils.ts:46](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L46)
 
 The user profile of the authenticated user the token is valid for.
 
@@ -126,7 +126,7 @@ The user profile of the authenticated user the token is valid for.
 
 > **sessionUid**: `string`
 
-Defined in: [src/JWTUtils.ts:49](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L49)
+Defined in: [src/JWTUtils.ts:49](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L49)
 
 The unique identifier of the user's authentication session.
 

package/docs/reference/interfaces/JWTUser.md

@@ -6,7 +6,7 @@
 
 # Interface: JWTUser
 
-Defined in: [src/JWTUtils.ts:13](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L13)
+Defined in: [src/JWTUtils.ts:13](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L13)
 
 Describes user data that is encoded in the payload of a JWT token.
 
@@ -20,7 +20,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **name**: `string`
 
-Defined in: [src/JWTUtils.ts:22](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L22)
+Defined in: [src/JWTUtils.ts:22](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L22)
 
 The unique name of the user.
 
@@ -30,7 +30,7 @@ The unique name of the user.
 
 > **roles**: `string`[]
 
-Defined in: [src/JWTUtils.ts:27](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L27)
+Defined in: [src/JWTUtils.ts:27](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L27)
 
 The list of roles (by name) that the user is apart of and will assume privileges for.
 
@@ -40,7 +40,7 @@ The list of roles (by name) that the user is apart of and will assume privileges
 
 > **uid**: `string`
 
-Defined in: [src/JWTUtils.ts:17](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L17)
+Defined in: [src/JWTUtils.ts:17](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L17)
 
 The universally unique identifier of the user.
 
@@ -50,6 +50,6 @@ The universally unique identifier of the user.
 
 > `optional` **verified?**: `boolean`
 
-Defined in: [src/JWTUtils.ts:32](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L32)
+Defined in: [src/JWTUtils.ts:32](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L32)
 
 Indicates if the user's e-mail address has been verified.

package/docs/reference/interfaces/JWTUtilsConfig.md

@@ -6,7 +6,7 @@
 
 # Interface: JWTUtilsConfig
 
-Defined in: [src/JWTUtils.ts:123](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L123)
+Defined in: [src/JWTUtils.ts:123](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L123)
 
 Describes the configuration options to be used with `JWTUtils` functions.
 
@@ -20,7 +20,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > `optional` **options?**: `VerifyOptions`
 
-Defined in: [src/JWTUtils.ts:132](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L132)
+Defined in: [src/JWTUtils.ts:132](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L132)
 
 The options to use when performing JWT signing or verification.
 
@@ -30,7 +30,7 @@ The options to use when performing JWT signing or verification.
 
 > `optional` **payload?**: [`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md) \| [`JWTUtilsPayloadPasswordOptions`](JWTUtilsPayloadPasswordOptions.md) \| [`JWTUtilsPayloadKeyOptions`](JWTUtilsPayloadKeyOptions.md)
 
-Defined in: [src/JWTUtils.ts:137](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L137)
+Defined in: [src/JWTUtils.ts:137](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L137)
 
 The options that determine how JWT token payloads will be handled.
 
@@ -40,6 +40,6 @@ The options that determine how JWT token payloads will be handled.
 
 > **secret**: `Secret`
 
-Defined in: [src/JWTUtils.ts:127](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L127)
+Defined in: [src/JWTUtils.ts:127](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L127)
 
 The secret to use for signing and verifying JWT tokens.