@rapidrest/core 1.0.1 → 1.1.0

package/docs/reference/enumerations/WorkerMessageType.md

@@ -2,11 +2,11 @@
 
 ***
 
-[@rapidrest/core](../README.md) / WorkerMessageType
+[@rapidrest/core](../globals.md) / WorkerMessageType
 
 # Enumeration: WorkerMessageType
 
-Defined in: src/threads/ThreadWorker.ts:7
+Defined in: [src/threads/ThreadWorker.ts:7](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/threads/ThreadWorker.ts:8](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L8)
 
 ***
 
@@ -24,7 +24,7 @@ Defined in: src/threads/ThreadWorker.ts:8
 
 > **LOG**: `"_WorkerLog"`
 
-Defined in: src/threads/ThreadWorker.ts:9
+Defined in: [src/threads/ThreadWorker.ts:9](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L9)
 
 ***
 
@@ -32,7 +32,7 @@ Defined in: src/threads/ThreadWorker.ts:9
 
 > **ONLINE**: `"_WorkerOnline"`
 
-Defined in: src/threads/ThreadWorker.ts:10
+Defined in: [src/threads/ThreadWorker.ts:10](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L10)
 
 ***
 
@@ -40,4 +40,4 @@ Defined in: src/threads/ThreadWorker.ts:10
 
 > **STOP**: `"_StopWorker"`
 
-Defined in: src/threads/ThreadWorker.ts:11
+Defined in: [src/threads/ThreadWorker.ts:11](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L11)

package/docs/reference/functions/sleep.md

@@ -2,13 +2,13 @@
 
 ***
 
-[@rapidrest/core](../README.md) / sleep
+[@rapidrest/core](../globals.md) / sleep
 
 # Function: sleep()
 
 > **sleep**(`ms`): `Promise`\<`void`\>
 
-Defined in: src/sleep.ts:8
+Defined in: [src/sleep.ts:8](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/sleep.ts#L8)
 
 Starts a timer to suspend execution for a given number of milliseconds.
 

package/docs/reference/globals.md

@@ -0,0 +1,73 @@
+[**@rapidrest/core**](README.md)
+
+***
+
+# @rapidrest/core
+
+## Namespaces
+
+- [ObjectDecorators](@rapidrest/namespaces/ObjectDecorators/README.md)
+
+## Enumerations
+
+- [AlertPriority](enumerations/AlertPriority.md)
+- [JWTUtilsCompressionMethods](enumerations/JWTUtilsCompressionMethods.md)
+- [WorkerMessageType](enumerations/WorkerMessageType.md)
+
+## Classes
+
+- [AlertUtils](classes/AlertUtils.md)
+- [ApiError](classes/ApiError.md)
+- [ClassLoader](classes/ClassLoader.md)
+- [Event](classes/Event.md)
+- [EventUtils](classes/EventUtils.md)
+- [FileUtils](classes/FileUtils.md)
+- [JWTUtils](classes/JWTUtils.md)
+- [MessagingUtils](classes/MessagingUtils.md)
+- [OASUtils](classes/OASUtils.md)
+- [ObjectFactory](classes/ObjectFactory.md)
+- [ObjectUtils](classes/ObjectUtils.md)
+- [StringUtils](classes/StringUtils.md)
+- [ThreadPool](classes/ThreadPool.md)
+- [ThreadWorker](classes/ThreadWorker.md)
+- [UserUtils](classes/UserUtils.md)
+- [ValidationUtils](classes/ValidationUtils.md)
+
+## Interfaces
+
+- [Alert](interfaces/Alert.md)
+- [AlertAttachment](interfaces/AlertAttachment.md)
+- [AlertClose](interfaces/AlertClose.md)
+- [AlertUtilsAttachmentOptions](interfaces/AlertUtilsAttachmentOptions.md)
+- [AlertUtilsOptions](interfaces/AlertUtilsOptions.md)
+- [InstanceOptions](interfaces/InstanceOptions.md)
+- [JWTPayload](interfaces/JWTPayload.md)
+- [JWTUser](interfaces/JWTUser.md)
+- [JWTUtilsConfig](interfaces/JWTUtilsConfig.md)
+- [JWTUtilsPayloadKeyOptions](interfaces/JWTUtilsPayloadKeyOptions.md)
+- [JWTUtilsPayloadOptions](interfaces/JWTUtilsPayloadOptions.md)
+- [JWTUtilsPayloadPasswordOptions](interfaces/JWTUtilsPayloadPasswordOptions.md)
+- [NewEvent](interfaces/NewEvent.md)
+- [OriginSettings](interfaces/OriginSettings.md)
+- [SlackConfig](interfaces/SlackConfig.md)
+- [SmtpAuth](interfaces/SmtpAuth.md)
+- [SmtpConfig](interfaces/SmtpConfig.md)
+- [Template](interfaces/Template.md)
+- [TemplateMapBase](interfaces/TemplateMapBase.md)
+- [TwilioConfig](interfaces/TwilioConfig.md)
+- [WorkerMessage](interfaces/WorkerMessage.md)
+- [WorkerOptions](interfaces/WorkerOptions.md)
+
+## Type Aliases
+
+- [BooleanFunc](type-aliases/BooleanFunc.md)
+- [TemplateMap](type-aliases/TemplateMap.md)
+- [WorkerCallback](type-aliases/WorkerCallback.md)
+
+## Variables
+
+- [Logger](variables/Logger.md)
+
+## Functions
+
+- [sleep](functions/sleep.md)

package/docs/reference/interfaces/Alert.md

@@ -2,11 +2,11 @@
 
 ***
 
-[@rapidrest/core](../README.md) / Alert
+[@rapidrest/core](../globals.md) / Alert
 
 # Interface: Alert
 
-Defined in: src/AlertUtils.ts:40
+Defined in: [src/AlertUtils.ts:40](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:42](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:44](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:46](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:48](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:50](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:52](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:54](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:56](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:58](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L58)
 
 A list of unique tags to associate with the event.

package/docs/reference/interfaces/AlertAttachment.md

@@ -2,11 +2,11 @@
 
 ***
 
-[@rapidrest/core](../README.md) / AlertAttachment
+[@rapidrest/core](../globals.md) / AlertAttachment
 
 # Interface: AlertAttachment
 
-Defined in: src/AlertUtils.ts:64
+Defined in: [src/AlertUtils.ts:64](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:66](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:68](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:70](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:72](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L72)
 
 The size of the attachment.

package/docs/reference/interfaces/AlertClose.md

@@ -2,11 +2,11 @@
 
 ***
 
-[@rapidrest/core](../README.md) / AlertClose
+[@rapidrest/core](../globals.md) / AlertClose
 
 # Interface: AlertClose
 
-Defined in: src/AlertUtils.ts:78
+Defined in: [src/AlertUtils.ts:78](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:82](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:80](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L80)
 
 Display name of the request source.

package/docs/reference/interfaces/AlertUtilsAttachmentOptions.md

@@ -2,11 +2,11 @@
 
 ***
 
-[@rapidrest/core](../README.md) / AlertUtilsAttachmentOptions
+[@rapidrest/core](../globals.md) / AlertUtilsAttachmentOptions
 
 # Interface: AlertUtilsAttachmentOptions
 
-Defined in: src/AlertUtils.ts:100
+Defined in: [src/AlertUtils.ts:100](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:102](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:104](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:109](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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

@@ -2,11 +2,11 @@
 
 ***
 
-[@rapidrest/core](../README.md) / AlertUtilsOptions
+[@rapidrest/core](../globals.md) / AlertUtilsOptions
 
 # Interface: AlertUtilsOptions
 
-Defined in: src/AlertUtils.ts:88
+Defined in: [src/AlertUtils.ts:88](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:90](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:94](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/AlertUtils.ts:92](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/AlertUtils.ts#L92)
 
 The full url of the REST API service that alerts will be sent to.

package/docs/reference/interfaces/InstanceOptions.md

@@ -2,11 +2,11 @@
 
 ***
 
-[@rapidrest/core](../README.md) / InstanceOptions
+[@rapidrest/core](../globals.md) / InstanceOptions
 
 # Interface: InstanceOptions
 
-Defined in: src/ObjectFactory.ts:11
+Defined in: [src/ObjectFactory.ts:11](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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:12
+Defined in: [src/ObjectFactory.ts:12](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L12)
 
 ***
 
@@ -24,7 +24,7 @@ Defined in: src/ObjectFactory.ts:12
 
 > `optional` **initialize**: `boolean`
 
-Defined in: src/ObjectFactory.ts:14
+Defined in: [src/ObjectFactory.ts:14](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L14)
 
 ***
 
@@ -32,4 +32,4 @@ Defined in: src/ObjectFactory.ts:14
 
 > `optional` **name**: `string`
 
-Defined in: src/ObjectFactory.ts:13
+Defined in: [src/ObjectFactory.ts:13](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L13)

package/docs/reference/interfaces/JWTPayload.md

@@ -2,11 +2,11 @@
 
 ***
 
-[@rapidrest/core](../README.md) / JWTPayload
+[@rapidrest/core](../globals.md) / JWTPayload
 
 # Interface: JWTPayload
 
-Defined in: src/JWTUtils.ts:38
+Defined in: [src/JWTUtils.ts:38](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:40](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:43](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:46](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:49](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L49)
 
 The unique identifier of the user's authentication session.
 

package/docs/reference/interfaces/JWTUser.md

@@ -2,11 +2,11 @@
 
 ***
 
-[@rapidrest/core](../README.md) / JWTUser
+[@rapidrest/core](../globals.md) / JWTUser
 
 # Interface: JWTUser
 
-Defined in: src/JWTUtils.ts:13
+Defined in: [src/JWTUtils.ts:13](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:22](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:27](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:32](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L32)
 
 Indicates if the user's e-mail address has been verified.

package/docs/reference/interfaces/JWTUtilsConfig.md

@@ -2,11 +2,11 @@
 
 ***
 
-[@rapidrest/core](../README.md) / JWTUtilsConfig
+[@rapidrest/core](../globals.md) / JWTUtilsConfig
 
 # Interface: JWTUtilsConfig
 
-Defined in: src/JWTUtils.ts:123
+Defined in: [src/JWTUtils.ts:123](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:132](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:137](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:127](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L127)
 
 The secret to use for signing and verifying JWT tokens.

package/docs/reference/interfaces/JWTUtilsPayloadKeyOptions.md

@@ -2,11 +2,11 @@
 
 ***
 
-[@rapidrest/core](../README.md) / JWTUtilsPayloadKeyOptions
+[@rapidrest/core](../globals.md) / JWTUtilsPayloadKeyOptions
 
 # Interface: JWTUtilsPayloadKeyOptions
 
-Defined in: src/JWTUtils.ts:106
+Defined in: [src/JWTUtils.ts:106](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L106)
 
 Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing
 key-based encryption.
@@ -25,7 +25,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > `optional` **compress**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
 
-Defined in: src/JWTUtils.ts:69
+Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L69)
 
 Set the method to use for compressing the payload profile, otherwise set to `null` for no compression.
 
@@ -39,7 +39,7 @@ Set the method to use for compressing the payload profile, otherwise set to `nul
 
 > `optional` **encrypt**: `boolean`
 
-Defined in: src/JWTUtils.ts:74
+Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:110](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/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
+Defined in: [src/JWTUtils.ts:115](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L115)
 
 The public key used to decrypt JWT token payloads.

package/docs/reference/interfaces/JWTUtilsPayloadOptions.md

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