@rapidrest/core 1.3.0 → 1.3.1

package/docs/reference/classes/JWTUtils.md

@@ -6,7 +6,7 @@
 
 # Class: JWTUtils
 
-Defined in: [src/JWTUtils.ts:145](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L145)
+Defined in: [src/JWTUtils.ts:145](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L145)
 
 Utility class for working with Json Web Token (JWT) authentication tokens.
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > `static` **createToken**(`config`, `user`, `data?`): `Promise`\<`string`\>
 
-Defined in: [src/JWTUtils.ts:170](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L170)
+Defined in: [src/JWTUtils.ts:172](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L172)
 
 #### Parameters
 
@@ -56,7 +56,7 @@ Defined in: [src/JWTUtils.ts:170](https://github.com/rapidrest/core/blob/df82e91
 
 > `static` **createTokenSync**(`config`, `user`, `data?`): `string`
 
-Defined in: [src/JWTUtils.ts:216](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L216)
+Defined in: [src/JWTUtils.ts:218](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L218)
 
 #### Parameters
 
@@ -82,7 +82,7 @@ Defined in: [src/JWTUtils.ts:216](https://github.com/rapidrest/core/blob/df82e91
 
 > `static` **decodeToken**(`config`, `token`): `Promise`\<[`JWTPayload`](../interfaces/JWTPayload.md)\>
 
-Defined in: [src/JWTUtils.ts:270](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L270)
+Defined in: [src/JWTUtils.ts:272](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L272)
 
 Decodes the given JWT authentication token using the provided configuration. If the token is not valid an
 error is thrown with the reason. Returns the encoded user object payload upon success.
@@ -113,7 +113,7 @@ The data encoded in the token's payload.
 
 > `static` **decodeTokenSync**(`config`, `token`): [`JWTPayload`](../interfaces/JWTPayload.md)
 
-Defined in: [src/JWTUtils.ts:320](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/JWTUtils.ts#L320)
+Defined in: [src/JWTUtils.ts:322](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L322)
 
 Decodes the given JWT authentication token using the provided configuration. If the token is not valid an
 error is thrown with the reason. Returns the encoded user object payload upon success.

package/docs/reference/classes/MessagingUtils.md

@@ -6,7 +6,7 @@
 
 # Class: MessagingUtils
 
-Defined in: [src/MessagingUtils.ts:75](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L75)
+Defined in: [src/MessagingUtils.ts:75](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L75)
 
 Simple utility class for sending templated messages via e-mail, SMS and more.
 
@@ -26,7 +26,7 @@ Simple utility class for sending templated messages via e-mail, SMS and more.
 
 > `protected` **slackApps**: `any`[] = `[]`
 
-Defined in: [src/MessagingUtils.ts:76](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L76)
+Defined in: [src/MessagingUtils.ts:76](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L76)
 
 ***
 
@@ -34,7 +34,7 @@ Defined in: [src/MessagingUtils.ts:76](https://github.com/rapidrest/core/blob/df
 
 > `protected` **slackConfigs**: `any`[] = `[]`
 
-Defined in: [src/MessagingUtils.ts:78](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L78)
+Defined in: [src/MessagingUtils.ts:78](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L78)
 
 ## Methods
 
@@ -42,7 +42,7 @@ Defined in: [src/MessagingUtils.ts:78](https://github.com/rapidrest/core/blob/df
 
 > **init**(): `Promise`\<`void`\>
 
-Defined in: [src/MessagingUtils.ts:96](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L96)
+Defined in: [src/MessagingUtils.ts:96](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L96)
 
 #### Returns
 
@@ -54,7 +54,7 @@ Defined in: [src/MessagingUtils.ts:96](https://github.com/rapidrest/core/blob/df
 
 > **loadTemplate**(`name`): [`Template`](../interfaces/Template.md)
 
-Defined in: [src/MessagingUtils.ts:160](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L160)
+Defined in: [src/MessagingUtils.ts:160](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L160)
 
 Loads the template with the given name and returns its contents as a string.
 
@@ -76,7 +76,7 @@ The name of the template to load.
 
 > **sendEmail**(`templateName`, `templateVars`, `options?`): `Promise`\<`any`\>
 
-Defined in: [src/MessagingUtils.ts:199](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L199)
+Defined in: [src/MessagingUtils.ts:199](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L199)
 
 Sends an email using the given template name and variables.
 
@@ -110,7 +110,7 @@ The map of additional options to pass into the sendMail function.
 
 > **sendSlack**(`templateName`, `templateVars`): `Promise`\<`any`[] \| `undefined`\>
 
-Defined in: [src/MessagingUtils.ts:243](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L243)
+Defined in: [src/MessagingUtils.ts:243](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L243)
 
 Sends an Slack message using the given template name and variables.
 
@@ -138,7 +138,7 @@ The map of variables to inject into the template.
 
 > **sendSMS**(`templateName`, `templateVars`, `options?`): `Promise`\<`any`\>
 
-Defined in: [src/MessagingUtils.ts:276](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/MessagingUtils.ts#L276)
+Defined in: [src/MessagingUtils.ts:276](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L276)
 
 Sends an SMS using the given template name and variables.
 

package/docs/reference/classes/OASUtils.md

@@ -6,7 +6,7 @@
 
 # Class: OASUtils
 
-Defined in: [src/OASUtils.ts:17](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L17)
+Defined in: [src/OASUtils.ts:17](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/OASUtils.ts#L17)
 
 ## Constructors
 
@@ -24,7 +24,7 @@ Defined in: [src/OASUtils.ts:17](https://github.com/rapidrest/core/blob/df82e91f
 
 > `static` **clearSpecCache**(): `void`
 
-Defined in: [src/OASUtils.ts:230](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L230)
+Defined in: [src/OASUtils.ts:230](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/OASUtils.ts#L230)
 
 Clears the spec parse cache. Useful in tests to force re-loading of specs.
 
@@ -38,7 +38,7 @@ Clears the spec parse cache. Useful in tests to force re-loading of specs.
 
 > `static` **getDatastore**(`spec`, `name`): `any`
 
-Defined in: [src/OASUtils.ts:25](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L25)
+Defined in: [src/OASUtils.ts:25](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/OASUtils.ts#L25)
 
 Gets the datastore definition with the specified name.
 
@@ -68,7 +68,7 @@ The definition for the datastore with the given name if found, otherwise `undefi
 
 > `static` **getObject**(`spec`, `path`): `any`
 
-Defined in: [src/OASUtils.ts:42](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L42)
+Defined in: [src/OASUtils.ts:42](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/OASUtils.ts#L42)
 
 Gets the specification object at the specified path.
 
@@ -98,7 +98,7 @@ The object at the specified path if found, otherwise `undefined`.
 
 > `static` **getResponse**(`obj`): `any`
 
-Defined in: [src/OASUtils.ts:69](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L69)
+Defined in: [src/OASUtils.ts:69](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/OASUtils.ts#L69)
 
 Returns the first available response object for a 2XX response as defined by the provided Operation schema object.
 
@@ -120,7 +120,7 @@ The Operation schema object to search.
 
 > `static` **getResponseContent**(`obj`): `any`
 
-Defined in: [src/OASUtils.ts:88](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L88)
+Defined in: [src/OASUtils.ts:88](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/OASUtils.ts#L88)
 
 Returns the first available response content object for a 2XX response as defined by the provided Operation schema object.
 
@@ -142,7 +142,7 @@ The Operation schema object to search.
 
 > `static` **getSchema**(`spec`, `name`): `any`
 
-Defined in: [src/OASUtils.ts:100](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L100)
+Defined in: [src/OASUtils.ts:100](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/OASUtils.ts#L100)
 
 Retrieves the schema definition with the given name.
 
@@ -172,7 +172,7 @@ The schema definition with the given name.
 
 > `static` **getTypeInfo**(`schemaDef`, `spec`, `convertDataType`): `any`
 
-Defined in: [src/OASUtils.ts:124](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L124)
+Defined in: [src/OASUtils.ts:124](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/OASUtils.ts#L124)
 
 Extracts the type information for a given schema Object definition.
 
@@ -208,7 +208,7 @@ A tuple containing the type, subType and subSchemaRef information.
 
 > `static` **loadSpec**(`file`): `Promise`\<`any`\>
 
-Defined in: [src/OASUtils.ts:179](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/OASUtils.ts#L179)
+Defined in: [src/OASUtils.ts:179](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/OASUtils.ts#L179)
 
 Attempts to load the Open API specification at the given path or URL.
 

package/docs/reference/classes/ObjectFactory.md

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

package/docs/reference/classes/ObjectUtils.md

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

package/docs/reference/classes/StringUtils.md

@@ -6,7 +6,7 @@
 
 # Class: StringUtils
 
-Defined in: [src/StringUtils.ts:10](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/StringUtils.ts#L10)
+Defined in: [src/StringUtils.ts:10](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/StringUtils.ts#L46)
+Defined in: [src/StringUtils.ts:46](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/StringUtils.ts#L18)
+Defined in: [src/StringUtils.ts:18](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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:87](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/StringUtils.ts#L87)
+Defined in: [src/StringUtils.ts:87](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/StringUtils.ts#L87)
 
 Replaces all instances of the match regex pattern with the contents of the inner regular expression pattern for
 the given string.
@@ -126,7 +126,7 @@ The fully replaced contents of the string.
 
 > `static` **toCamelCase**(`str`): `string`
 
-Defined in: [src/StringUtils.ts:104](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/StringUtils.ts#L104)
+Defined in: [src/StringUtils.ts:104](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/StringUtils.ts#L104)
 
 Converts the first character in the given string to be lowercase (e.g. myVariable).
 
@@ -150,7 +150,7 @@ The string converted to camelCase.
 
 > `static` **toPascalCase**(`str`): `string`
 
-Defined in: [src/StringUtils.ts:114](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/StringUtils.ts#L114)
+Defined in: [src/StringUtils.ts:114](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/StringUtils.ts#L114)
 
 Converts the first character in the given string to be uppercase (e.g. MyVariable).
 

package/docs/reference/classes/ThreadPool.md

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

package/docs/reference/classes/ThreadWorker.md

@@ -6,7 +6,7 @@
 
 # Abstract Class: ThreadWorker
 
-Defined in: [src/threads/ThreadWorker.ts:29](https://github.com/rapidrest/core/blob/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L29)
+Defined in: [src/threads/ThreadWorker.ts:29](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L32)
+Defined in: [src/threads/ThreadWorker.ts:32](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L30)
+Defined in: [src/threads/ThreadWorker.ts:30](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L41)
+Defined in: [src/threads/ThreadWorker.ts:41](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L46)
+Defined in: [src/threads/ThreadWorker.ts:46](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/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/df82e91f4c858ef61526c7f35789a4199b84d999/src/threads/ThreadWorker.ts#L51)
+Defined in: [src/threads/ThreadWorker.ts:51](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadWorker.ts#L51)
 
 Stops execution of all work and shuts down the thread worker.
 

package/docs/reference/classes/UserUtils.md

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