@rapidrest/core 1.1.0 → 1.2.0

package/docs/reference/interfaces/Alert.md

@@ -6,7 +6,7 @@
 
 # Interface: Alert
 
-Defined in: [src/AlertUtils.ts:40](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L40)
+Defined in: [src/AlertUtils.ts:40](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L42)
+Defined in: [src/AlertUtils.ts:42](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L44)
+Defined in: [src/AlertUtils.ts:44](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L44)
 
 The detailed information about the event that has occurred.
 
@@ -34,9 +34,9 @@ The detailed information about the event that has occurred.
 
 ### details?
 
-> `optional` **details**: `any`
+> `optional` **details?**: `any`
 
-Defined in: [src/AlertUtils.ts:46](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L46)
+Defined in: [src/AlertUtils.ts:46](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L46)
 
 A key-value map of custom information about the alert.
 
@@ -44,9 +44,9 @@ A key-value map of custom information about the alert.
 
 ### entity?
 
-> `optional` **entity**: `string`
+> `optional` **entity?**: `string`
 
-Defined in: [src/AlertUtils.ts:48](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L48)
+Defined in: [src/AlertUtils.ts:48](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L50)
+Defined in: [src/AlertUtils.ts:50](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L50)
 
 The basic summary of the alert that describes the event.
 
@@ -64,9 +64,9 @@ The basic summary of the alert that describes the event.
 
 ### note?
 
-> `optional` **note**: `string`
+> `optional` **note?**: `string`
 
-Defined in: [src/AlertUtils.ts:52](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L52)
+Defined in: [src/AlertUtils.ts:52](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L54)
+Defined in: [src/AlertUtils.ts:54](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L56)
+Defined in: [src/AlertUtils.ts:56](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L56)
 
 The source of the alert. Can be a pod/service name, IP address or other unique identifier.
 
@@ -94,8 +94,8 @@ The source of the alert. Can be a pod/service name, IP address or other unique i
 
 ### tags?
 
-> `optional` **tags**: `string`[]
+> `optional` **tags?**: `string`[]
 
-Defined in: [src/AlertUtils.ts:58](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L58)
+Defined in: [src/AlertUtils.ts:58](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L64)
+Defined in: [src/AlertUtils.ts:64](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L66)
+Defined in: [src/AlertUtils.ts:66](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L68)
+Defined in: [src/AlertUtils.ts:68](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L70)
+Defined in: [src/AlertUtils.ts:70](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L70)
 
 The name of the attachment.
 
@@ -44,8 +44,8 @@ The name of the attachment.
 
 ### size?
 
-> `optional` **size**: `number`
+> `optional` **size?**: `number`
 
-Defined in: [src/AlertUtils.ts:72](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L72)
+Defined in: [src/AlertUtils.ts:72](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L78)
+Defined in: [src/AlertUtils.ts:78](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L78)
 
 Describes a request to close an alert.
 
@@ -14,9 +14,9 @@ Describes a request to close an alert.
 
 ### note?
 
-> `optional` **note**: `string`
+> `optional` **note?**: `string`
 
-Defined in: [src/AlertUtils.ts:82](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L82)
+Defined in: [src/AlertUtils.ts:82](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L82)
 
 Additional alert note to add.
 
@@ -24,8 +24,8 @@ Additional alert note to add.
 
 ### source?
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
-Defined in: [src/AlertUtils.ts:80](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L80)
+Defined in: [src/AlertUtils.ts:80](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L100)
+Defined in: [src/AlertUtils.ts:100](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L102)
+Defined in: [src/AlertUtils.ts:102](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L102)
 
 The attachment files to upload with the alert.
 
@@ -24,9 +24,9 @@ The attachment files to upload with the alert.
 
 ### indexFile?
 
-> `optional` **indexFile**: `string`
+> `optional` **indexFile?**: `string`
 
-Defined in: [src/AlertUtils.ts:104](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L104)
+Defined in: [src/AlertUtils.ts:104](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L104)
 
 The name of the index file when the attachment is a zip file.
 
@@ -34,9 +34,9 @@ The name of the index file when the attachment is a zip file.
 
 ### zip?
 
-> `optional` **zip**: `boolean`
+> `optional` **zip?**: `boolean`
 
-Defined in: [src/AlertUtils.ts:109](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L109)
+Defined in: [src/AlertUtils.ts:109](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L88)
+Defined in: [src/AlertUtils.ts:88](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L90)
+Defined in: [src/AlertUtils.ts:90](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/AlertUtils.ts#L90)
 
 The value of the Authorization header to apply to all outgoing HTTP requests.
 
@@ -24,9 +24,9 @@ The value of the Authorization header to apply to all outgoing HTTP requests.
 
 ### logger?
 
-> `optional` **logger**: `any`
+> `optional` **logger?**: `any`
 
-Defined in: [src/AlertUtils.ts:94](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L94)
+Defined in: [src/AlertUtils.ts:94](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L92)
+Defined in: [src/AlertUtils.ts:92](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L11)
+Defined in: [src/ObjectFactory.ts:11](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L11)
 
 The set of options to use when creating new instances of objects.
 
@@ -14,22 +14,28 @@ The set of options to use when creating new instances of objects.
 
 ### args?
 
-> `optional` **args**: `any`[]
+> `optional` **args?**: `any`[]
 
-Defined in: [src/ObjectFactory.ts:12](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L12)
+Defined in: [src/ObjectFactory.ts:13](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L13)
+
+The list of arguments to pass to the class constructor.
 
 ***
 
 ### initialize?
 
-> `optional` **initialize**: `boolean`
+> `optional` **initialize?**: `boolean`
+
+Defined in: [src/ObjectFactory.ts:17](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L17)
 
-Defined in: [src/ObjectFactory.ts:14](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L14)
+Set to `true` to perform initialization of the object after creation, otherwise set to `false`. Default is `true`.
 
 ***
 
 ### name?
 
-> `optional` **name**: `string`
+> `optional` **name?**: `string`
+
+Defined in: [src/ObjectFactory.ts:15](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L15)
 
-Defined in: [src/ObjectFactory.ts:13](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L13)
+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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L38)
+Defined in: [src/JWTUtils.ts:38](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L38)
 
 Describes the payload data structure of signed JWT tokens.
 
@@ -16,13 +16,13 @@ Describes the payload data structure of signed JWT tokens.
 
 ## Indexable
 
-\[`key`: `string`\]: `any`
+> \[`key`: `string`\]: `any`
 
 ## Properties
 
 ### aud?
 
-> `optional` **aud**: `string` \| `string`[]
+> `optional` **aud?**: `string` \| `string`[]
 
 Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:115
 
@@ -34,9 +34,9 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:115
 
 ### compression?
 
-> `optional` **compression**: `"zlib"`
+> `optional` **compression?**: `"zlib"`
 
-Defined in: [src/JWTUtils.ts:40](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L40)
+Defined in: [src/JWTUtils.ts:40](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L40)
 
 Indicates if the payload profile has been compressed and with what method.
 
@@ -44,9 +44,9 @@ Indicates if the payload profile has been compressed and with what method.
 
 ### encryption?
 
-> `optional` **encryption**: `boolean`
+> `optional` **encryption?**: `boolean`
 
-Defined in: [src/JWTUtils.ts:43](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L43)
+Defined in: [src/JWTUtils.ts:43](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L43)
 
 Indicates if the payload profile has been encrypted.
 
@@ -54,7 +54,7 @@ Indicates if the payload profile has been encrypted.
 
 ### exp?
 
-> `optional` **exp**: `number`
+> `optional` **exp?**: `number`
 
 Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:116
 
@@ -66,7 +66,7 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:116
 
 ### iat?
 
-> `optional` **iat**: `number`
+> `optional` **iat?**: `number`
 
 Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:118
 
@@ -78,7 +78,7 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:118
 
 ### iss?
 
-> `optional` **iss**: `string`
+> `optional` **iss?**: `string`
 
 Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:113
 
@@ -90,7 +90,7 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:113
 
 ### jti?
 
-> `optional` **jti**: `string`
+> `optional` **jti?**: `string`
 
 Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:119
 
@@ -102,7 +102,7 @@ Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:119
 
 ### nbf?
 
-> `optional` **nbf**: `number`
+> `optional` **nbf?**: `number`
 
 Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:117
 
@@ -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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L46)
+Defined in: [src/JWTUtils.ts:46](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L49)
+Defined in: [src/JWTUtils.ts:49](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L49)
 
 The unique identifier of the user's authentication session.
 
@@ -134,7 +134,7 @@ The unique identifier of the user's authentication session.
 
 ### sub?
 
-> `optional` **sub**: `string`
+> `optional` **sub?**: `string`
 
 Defined in: node\_modules/@types/jsonwebtoken/index.d.ts:114
 

package/docs/reference/interfaces/JWTUser.md

@@ -6,7 +6,7 @@
 
 # Interface: JWTUser
 
-Defined in: [src/JWTUtils.ts:13](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L13)
+Defined in: [src/JWTUtils.ts:13](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L22)
+Defined in: [src/JWTUtils.ts:22](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L27)
+Defined in: [src/JWTUtils.ts:27](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L17)
+Defined in: [src/JWTUtils.ts:17](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L17)
 
 The universally unique identifier of the user.
 
@@ -48,8 +48,8 @@ The universally unique identifier of the user.
 
 ### verified?
 
-> `optional` **verified**: `boolean`
+> `optional` **verified?**: `boolean`
 
-Defined in: [src/JWTUtils.ts:32](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L32)
+Defined in: [src/JWTUtils.ts:32](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L123)
+Defined in: [src/JWTUtils.ts:123](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L123)
 
 Describes the configuration options to be used with `JWTUtils` functions.
 
@@ -18,9 +18,9 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 ### options?
 
-> `optional` **options**: `VerifyOptions`
+> `optional` **options?**: `VerifyOptions`
 
-Defined in: [src/JWTUtils.ts:132](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L132)
+Defined in: [src/JWTUtils.ts:132](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L132)
 
 The options to use when performing JWT signing or verification.
 
@@ -28,9 +28,9 @@ The options to use when performing JWT signing or verification.
 
 ### payload?
 
-> `optional` **payload**: [`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md) \| [`JWTUtilsPayloadPasswordOptions`](JWTUtilsPayloadPasswordOptions.md) \| [`JWTUtilsPayloadKeyOptions`](JWTUtilsPayloadKeyOptions.md)
+> `optional` **payload?**: [`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md) \| [`JWTUtilsPayloadPasswordOptions`](JWTUtilsPayloadPasswordOptions.md) \| [`JWTUtilsPayloadKeyOptions`](JWTUtilsPayloadKeyOptions.md)
 
-Defined in: [src/JWTUtils.ts:137](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L137)
+Defined in: [src/JWTUtils.ts:137](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L127)
+Defined in: [src/JWTUtils.ts:127](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L127)
 
 The secret to use for signing and verifying JWT tokens.

package/docs/reference/interfaces/JWTUtilsPayloadKeyOptions.md

@@ -6,9 +6,9 @@
 
 # Interface: JWTUtilsPayloadKeyOptions
 
-Defined in: [src/JWTUtils.ts:106](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L106)
+Defined in: [src/JWTUtils.ts:106](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L106)
 
-Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing
+Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing
 key-based encryption.
 
 ## Author
@@ -23,9 +23,9 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 ### compress?
 
-> `optional` **compress**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
+> `optional` **compress?**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
 
-Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L69)
+Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L69)
 
 Set the method to use for compressing the payload profile, otherwise set to `null` for no compression.
 
@@ -37,9 +37,9 @@ Set the method to use for compressing the payload profile, otherwise set to `nul
 
 ### encrypt?
 
-> `optional` **encrypt**: `boolean`
+> `optional` **encrypt?**: `boolean`
 
-Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L74)
+Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L74)
 
 Set to `true` to indicate that the JWT token payload is encrypted, otherwise set to `false`.
 
@@ -53,7 +53,7 @@ Set to `true` to indicate that the JWT token payload is encrypted, otherwise set
 
 > **private\_key**: `string`
 
-Defined in: [src/JWTUtils.ts:110](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L110)
+Defined in: [src/JWTUtils.ts:110](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L110)
 
 The private key used to encrypt JWT token payloads.
 
@@ -63,6 +63,6 @@ The private key used to encrypt JWT token payloads.
 
 > **public\_key**: `string`
 
-Defined in: [src/JWTUtils.ts:115](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L115)
+Defined in: [src/JWTUtils.ts:115](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L115)
 
 The public key used to decrypt JWT token payloads.

package/docs/reference/interfaces/JWTUtilsPayloadOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: JWTUtilsPayloadOptions
 
-Defined in: [src/JWTUtils.ts:65](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L65)
+Defined in: [src/JWTUtils.ts:65](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L65)
 
 Describes the configuration options to be used with the `JWTUtilsConfig.payload` property.
 
@@ -23,9 +23,9 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 ### compress?
 
-> `optional` **compress**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
+> `optional` **compress?**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
 
-Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L69)
+Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L69)
 
 Set the method to use for compressing the payload profile, otherwise set to `null` for no compression.
 
@@ -33,8 +33,8 @@ Set the method to use for compressing the payload profile, otherwise set to `nul
 
 ### encrypt?
 
-> `optional` **encrypt**: `boolean`
+> `optional` **encrypt?**: `boolean`
 
-Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L74)
+Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L74)
 
 Set to `true` to indicate that the JWT token payload is encrypted, otherwise set to `false`.

package/docs/reference/interfaces/JWTUtilsPayloadPasswordOptions.md

@@ -6,9 +6,9 @@
 
 # Interface: JWTUtilsPayloadPasswordOptions
 
-Defined in: [src/JWTUtils.ts:83](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L83)
+Defined in: [src/JWTUtils.ts:83](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L83)
 
-Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing password
+Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing password
 based encryption.
 
 ## Author
@@ -25,7 +25,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **algorithm**: `string`
 
-Defined in: [src/JWTUtils.ts:87](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L87)
+Defined in: [src/JWTUtils.ts:87](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L87)
 
 The cryptographic cipher algorithm to use during encryption/decryption of a JWT token payload.
 
@@ -33,9 +33,9 @@ The cryptographic cipher algorithm to use during encryption/decryption of a JWT
 
 ### compress?
 
-> `optional` **compress**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
+> `optional` **compress?**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
 
-Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L69)
+Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L69)
 
 Set the method to use for compressing the payload profile, otherwise set to `null` for no compression.
 
@@ -47,9 +47,9 @@ Set the method to use for compressing the payload profile, otherwise set to `nul
 
 ### encrypt?
 
-> `optional` **encrypt**: `boolean`
+> `optional` **encrypt?**: `boolean`
 
-Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L74)
+Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L74)
 
 Set to `true` to indicate that the JWT token payload is encrypted, otherwise set to `false`.
 
@@ -63,7 +63,7 @@ Set to `true` to indicate that the JWT token payload is encrypted, otherwise set
 
 > **iv**: `Buffer`
 
-Defined in: [src/JWTUtils.ts:92](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L92)
+Defined in: [src/JWTUtils.ts:92](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L92)
 
 The initialization vector to use during encryption and decryption.
 
@@ -73,6 +73,6 @@ The initialization vector to use during encryption and decryption.
 
 > **password**: `string`
 
-Defined in: [src/JWTUtils.ts:97](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L97)
+Defined in: [src/JWTUtils.ts:97](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L97)
 
 The password to use when encrypting or decrypting JWT token payloads.