@rapidrest/core 1.1.0 → 1.2.0

package/docs/reference/classes/Event.md

@@ -6,7 +6,7 @@
 
 # Class: Event
 
-Defined in: [src/TelemetryUtils.ts:23](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L23)
+Defined in: [src/TelemetryUtils.ts:23](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L23)
 
 Describes a single telemetry event. A telemetry event is when something occurs in the system.
 
@@ -24,7 +24,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new Event**(`config`, `userId`, `data`): `Event`
 
-Defined in: [src/TelemetryUtils.ts:54](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L54)
+Defined in: [src/TelemetryUtils.ts:54](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L54)
 
 #### Parameters
 
@@ -50,7 +50,7 @@ Defined in: [src/TelemetryUtils.ts:54](https://github.com/rapidrest/core/blob/23
 
 > `readonly` **environment**: `string`
 
-Defined in: [src/TelemetryUtils.ts:32](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L32)
+Defined in: [src/TelemetryUtils.ts:32](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L32)
 
 The name of the environment that the event originated from. This is typically `dev` or `prod`.
 
@@ -60,7 +60,7 @@ The name of the environment that the event originated from. This is typically `d
 
 > `readonly` **origin**: `string`
 
-Defined in: [src/TelemetryUtils.ts:37](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L37)
+Defined in: [src/TelemetryUtils.ts:37](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L37)
 
 The unique name of the service or client that the event originated from.
 
@@ -70,7 +70,7 @@ The unique name of the service or client that the event originated from.
 
 > `readonly` **timestamp**: `Date`
 
-Defined in: [src/TelemetryUtils.ts:42](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L42)
+Defined in: [src/TelemetryUtils.ts:42](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L42)
 
 The date and time that the event occured.
 
@@ -80,7 +80,7 @@ The date and time that the event occured.
 
 > `readonly` **type**: `string`
 
-Defined in: [src/TelemetryUtils.ts:47](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L47)
+Defined in: [src/TelemetryUtils.ts:47](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L47)
 
 The type of event being recorded.
 
@@ -94,7 +94,7 @@ The type of event being recorded.
 
 > `readonly` **uid**: `string`
 
-Defined in: [src/TelemetryUtils.ts:27](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L27)
+Defined in: [src/TelemetryUtils.ts:27](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L27)
 
 The universally unique identifier of the event.
 
@@ -104,6 +104,6 @@ The universally unique identifier of the event.
 
 > `readonly` **userId**: `string`
 
-Defined in: [src/TelemetryUtils.ts:52](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L52)
+Defined in: [src/TelemetryUtils.ts:52](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L52)
 
 The universally unique identifer of the user that sent the event.

package/docs/reference/classes/EventUtils.md

@@ -6,7 +6,7 @@
 
 # Class: EventUtils
 
-Defined in: [src/TelemetryUtils.ts:84](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L84)
+Defined in: [src/TelemetryUtils.ts:84](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L84)
 
 Provides a common set of static functions for recording and working with telemetry `Event` instances.
 
@@ -37,7 +37,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > `static` **init**(`config`, `logger`, `jwtToken`): `void`
 
-Defined in: [src/TelemetryUtils.ts:99](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L99)
+Defined in: [src/TelemetryUtils.ts:99](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L99)
 
 Initializes `EventUtils` with the provided defaults.
 
@@ -71,7 +71,7 @@ The user's JWT token to send telemetry events on behalf of.
 
 > `static` **on**(`type`, `callback`): `void`
 
-Defined in: [src/TelemetryUtils.ts:173](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L173)
+Defined in: [src/TelemetryUtils.ts:173](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L173)
 
 Registers a `callback` function to receive notifications of recorded events of the given `type`. Note that only
 events originating from the same application or service will be notified.
@@ -100,7 +100,7 @@ The function to call when an event is recorded.
 
 > `static` **record**(`evt`, `type?`): `Promise`\<`void`\>
 
-Defined in: [src/TelemetryUtils.ts:118](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L118)
+Defined in: [src/TelemetryUtils.ts:118](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L118)
 
 Sends the given event to the telemetry service for permanent recording.
 

package/docs/reference/classes/FileUtils.md

@@ -6,7 +6,7 @@
 
 # Class: FileUtils
 
-Defined in: [src/FileUtils.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/FileUtils.ts#L17)
+Defined in: [src/FileUtils.ts:17](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/FileUtils.ts#L17)
 
 Utility functions for working with files.
 
@@ -28,9 +28,9 @@ Jean-Philippe Steinmetz
 
 ### copyBinaryFile()
 
-> `static` **copyBinaryFile**(`srcPath`, `outPath`, `variables`): `Promise`\<`void`\>
+> `static` **copyBinaryFile**(`srcPath`, `outPath`, `variables?`): `Promise`\<`void`\>
 
-Defined in: [src/FileUtils.ts:159](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/FileUtils.ts#L159)
+Defined in: [src/FileUtils.ts:159](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/FileUtils.ts#L159)
 
 Generates a copy of the source file at the desired output destination using binary copy mode.
 
@@ -48,7 +48,7 @@ The source file to copy.
 
 The destination file to generate.
 
-##### variables
+##### variables?
 
 `any` = `{}`
 
@@ -62,9 +62,9 @@ The map of variable names to values to swap. Applies to outPath only.
 
 ### copyDirectory()
 
-> `static` **copyDirectory**(`srcPath`, `outPath`, `vars`, `excludeFilters`, `binaryFilters`, `force`): `Promise`\<`void`\>
+> `static` **copyDirectory**(`srcPath`, `outPath`, `vars?`, `excludeFilters?`, `binaryFilters?`, `force?`): `Promise`\<`void`\>
 
-Defined in: [src/FileUtils.ts:187](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/FileUtils.ts#L187)
+Defined in: [src/FileUtils.ts:187](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/FileUtils.ts#L187)
 
 Performs a deep copy of a directory tree at the given srcPath to the specified output directory. Performs
 template replacement for all variables given and skips any files in the specified filter.
@@ -83,25 +83,25 @@ The path to the source directory to copy files from.
 
 The path to the destination directory to copy files to.
 
-##### vars
+##### vars?
 
 `any` = `{}`
 
 The map of template variables to perform replacement on.
 
-##### excludeFilters
+##### excludeFilters?
 
 `string`[] = `[]`
 
 The list of file extension filters to exclude during the copy process.
 
-##### binaryFilters
+##### binaryFilters?
 
 `string`[] = `[]`
 
 The list of file extension filters to copy as binary only.
 
-##### force
+##### force?
 
 `boolean` = `false`
 
@@ -115,9 +115,9 @@ Set to `true` to force writing over any existing files.
 
 ### copyFile()
 
-> `static` **copyFile**(`srcPath`, `outPath`, `variables`, `overwrite`): `Promise`\<`void`\>
+> `static` **copyFile**(`srcPath`, `outPath`, `variables?`, `overwrite?`): `Promise`\<`void`\>
 
-Defined in: [src/FileUtils.ts:123](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/FileUtils.ts#L123)
+Defined in: [src/FileUtils.ts:123](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/FileUtils.ts#L123)
 
 Generates a copy of the source file at the desired output destination and performs a swap of all values of the
 variables specified.
@@ -136,13 +136,13 @@ The source file to copy.
 
 The destination file to generate.
 
-##### variables
+##### variables?
 
 `any` = `{}`
 
 The map of variable names to values to swap.
 
-##### overwrite
+##### overwrite?
 
 `boolean` = `false`
 
@@ -154,9 +154,9 @@ The map of variable names to values to swap.
 
 ### writeFile()
 
-> `static` **writeFile**(`srcPath`, `outPath`, `contents`, `overwrite`): `Promise`\<`void`\>
+> `static` **writeFile**(`srcPath`, `outPath`, `contents`, `overwrite?`): `Promise`\<`void`\>
 
-Defined in: [src/FileUtils.ts:28](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/FileUtils.ts#L28)
+Defined in: [src/FileUtils.ts:28](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/FileUtils.ts#L28)
 
 Attempts to write the provided contents to the file path given. If a file already exists the user is prompted to
 allow the file to be overwritten or merged. In the case of a merge, srcPath is used as a baseline in order to
@@ -182,7 +182,7 @@ The destination file path to be written.
 
 The contents of the file to write.
 
-##### overwrite
+##### overwrite?
 
 `boolean` = `false`
 

package/docs/reference/classes/JWTUtils.md

@@ -6,7 +6,7 @@
 
 # Class: JWTUtils
 
-Defined in: [src/JWTUtils.ts:145](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L145)
+Defined in: [src/JWTUtils.ts:145](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L145)
 
 Utility class for working with Json Web Token (JWT) authentication tokens.
 
@@ -30,9 +30,9 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > `static` **createToken**(`config`, `user`, `data?`): `string`
 
-Defined in: [src/JWTUtils.ts:154](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L154)
+Defined in: [src/JWTUtils.ts:154](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L154)
 
-Generates a new JWT token for the given config and user object. The user object must be a valid RapidREST
+Generates a new JWT token for the given config and user object. The user object must be a valid RapidREST
 user.
 
 #### Parameters
@@ -65,9 +65,9 @@ Additional data to include the token's payload.
 
 > `static` **decodeToken**(`config`, `token`): [`JWTPayload`](../interfaces/JWTPayload.md)
 
-Defined in: [src/JWTUtils.ts:207](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L207)
+Defined in: [src/JWTUtils.ts:208](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/JWTUtils.ts#L208)
 
-Decodes the given JWT authentication token using the provided configuration. If the token is not valid an
+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.
 
 #### Parameters

package/docs/reference/classes/MessagingUtils.md

@@ -6,7 +6,7 @@
 
 # Class: MessagingUtils
 
-Defined in: [src/MessagingUtils.ts:75](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L75)
+Defined in: [src/MessagingUtils.ts:75](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L76)
+Defined in: [src/MessagingUtils.ts:76](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L76)
 
 ***
 
@@ -34,7 +34,7 @@ Defined in: [src/MessagingUtils.ts:76](https://github.com/rapidrest/core/blob/23
 
 > `protected` **slackConfigs**: `any`[] = `[]`
 
-Defined in: [src/MessagingUtils.ts:78](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L78)
+Defined in: [src/MessagingUtils.ts:78](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L78)
 
 ## Methods
 
@@ -42,7 +42,7 @@ Defined in: [src/MessagingUtils.ts:78](https://github.com/rapidrest/core/blob/23
 
 > **init**(): `Promise`\<`void`\>
 
-Defined in: [src/MessagingUtils.ts:90](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L90)
+Defined in: [src/MessagingUtils.ts:90](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L90)
 
 #### Returns
 
@@ -54,7 +54,7 @@ Defined in: [src/MessagingUtils.ts:90](https://github.com/rapidrest/core/blob/23
 
 > **loadTemplate**(`name`): [`Template`](../interfaces/Template.md)
 
-Defined in: [src/MessagingUtils.ts:152](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L152)
+Defined in: [src/MessagingUtils.ts:152](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L152)
 
 Loads the template with the given name and returns its contents as a string.
 
@@ -74,9 +74,9 @@ The name of the template to load.
 
 ### sendEmail()
 
-> **sendEmail**(`templateName`, `templateVars`, `options`): `Promise`\<`any`\>
+> **sendEmail**(`templateName`, `templateVars`, `options?`): `Promise`\<`any`\>
 
-Defined in: [src/MessagingUtils.ts:184](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L184)
+Defined in: [src/MessagingUtils.ts:184](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L184)
 
 Sends an email using the given template name and variables.
 
@@ -94,7 +94,7 @@ The name of the email template to send.
 
 The map of variables to inject into the template.
 
-##### options
+##### options?
 
 `any` = `{}`
 
@@ -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:236](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L236)
+Defined in: [src/MessagingUtils.ts:236](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L236)
 
 Sends an Slack message using the given template name and variables.
 
@@ -136,9 +136,9 @@ The map of variables to inject into the template.
 
 ### sendSMS()
 
-> **sendSMS**(`templateName`, `templateVars`, `options`): `Promise`\<`any`\>
+> **sendSMS**(`templateName`, `templateVars`, `options?`): `Promise`\<`any`\>
 
-Defined in: [src/MessagingUtils.ts:270](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L270)
+Defined in: [src/MessagingUtils.ts:270](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L270)
 
 Sends an SMS using the given template name and variables.
 
@@ -156,7 +156,7 @@ The name of the SMS template to send.
 
 The map of variables to inject into the template.
 
-##### options
+##### options?
 
 `any` = `{}`
 

package/docs/reference/classes/OASUtils.md

@@ -6,7 +6,7 @@
 
 # Class: OASUtils
 
-Defined in: [src/OASUtils.ts:12](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/OASUtils.ts#L12)
+Defined in: [src/OASUtils.ts:12](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/OASUtils.ts#L12)
 
 ## Constructors
 
@@ -24,7 +24,7 @@ Defined in: [src/OASUtils.ts:12](https://github.com/rapidrest/core/blob/23a4f312
 
 > `static` **getDatastore**(`spec`, `name`): `any`
 
-Defined in: [src/OASUtils.ts:20](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/OASUtils.ts#L20)
+Defined in: [src/OASUtils.ts:20](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/OASUtils.ts#L20)
 
 Gets the datastore definition with the specified name.
 
@@ -54,7 +54,7 @@ The definition for the datastore with the given name if found, otherwise `undefi
 
 > `static` **getObject**(`spec`, `path`): `any`
 
-Defined in: [src/OASUtils.ts:37](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/OASUtils.ts#L37)
+Defined in: [src/OASUtils.ts:37](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/OASUtils.ts#L37)
 
 Gets the specification object at the specified path.
 
@@ -84,7 +84,7 @@ The object at the specified path if found, otherwise `undefined`.
 
 > `static` **getResponse**(`obj`): `any`
 
-Defined in: [src/OASUtils.ts:64](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/OASUtils.ts#L64)
+Defined in: [src/OASUtils.ts:64](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/OASUtils.ts#L64)
 
 Returns the first available response object for a 2XX response as defined by the provided Operation schema object.
 
@@ -106,7 +106,7 @@ The Operation schema object to search.
 
 > `static` **getResponseContent**(`obj`): `any`
 
-Defined in: [src/OASUtils.ts:83](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/OASUtils.ts#L83)
+Defined in: [src/OASUtils.ts:83](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/OASUtils.ts#L83)
 
 Returns the first available response content object for a 2XX response as defined by the provided Operation schema object.
 
@@ -128,7 +128,7 @@ The Operation schema object to search.
 
 > `static` **getSchema**(`spec`, `name`): `any`
 
-Defined in: [src/OASUtils.ts:95](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/OASUtils.ts#L95)
+Defined in: [src/OASUtils.ts:95](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/OASUtils.ts#L95)
 
 Retrieves the schema definition with the given name.
 
@@ -158,7 +158,7 @@ The schema definition with the given name.
 
 > `static` **getTypeInfo**(`schemaDef`, `spec`, `convertDataType`): `any`
 
-Defined in: [src/OASUtils.ts:118](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/OASUtils.ts#L118)
+Defined in: [src/OASUtils.ts:118](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/OASUtils.ts#L118)
 
 Extracts the type information for a given schema Object definition.
 
@@ -194,7 +194,7 @@ A tuple containing the type, subType and subSchemaRef information.
 
 > `static` **loadSpec**(`file`): `Promise`\<`any`\>
 
-Defined in: [src/OASUtils.ts:173](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/OASUtils.ts#L173)
+Defined in: [src/OASUtils.ts:173](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/OASUtils.ts#L173)
 
 Attempts to load the Open API specification at the given path or URL.
 

package/docs/reference/classes/ObjectFactory.md

@@ -6,10 +6,10 @@
 
 # Class: ObjectFactory
 
-Defined in: [src/ObjectFactory.ts:24](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L24)
+Defined in: [src/ObjectFactory.ts:27](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L27)
 
-The `ObjectFactory` is a manager for creating objects based on registered
-class types. This allows for the tracking of multiple instances of objects
+The `ObjectFactory` is a manager for creating objects based on registered
+class types. This allows for the tracking of multiple instances of objects
 so that references can be referenced by unique name.
 
 ## Author
@@ -22,7 +22,7 @@ Jean-Philippe Steinmetz
 
 > **new ObjectFactory**(`config?`, `logger?`): `ObjectFactory`
 
-Defined in: [src/ObjectFactory.ts:37](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L37)
+Defined in: [src/ObjectFactory.ts:40](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L40)
 
 #### Parameters
 
@@ -44,7 +44,7 @@ Defined in: [src/ObjectFactory.ts:37](https://github.com/rapidrest/core/blob/23a
 
 > `readonly` **classes**: `Map`\<`string`, `any`\>
 
-Defined in: [src/ObjectFactory.ts:26](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L26)
+Defined in: [src/ObjectFactory.ts:29](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L29)
 
 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:29](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L29)
+Defined in: [src/ObjectFactory.ts:32](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L32)
 
 The global application configuration object.
 
@@ -64,7 +64,7 @@ The global application configuration object.
 
 > `readonly` **instances**: `Map`\<`string`, `any`\>
 
-Defined in: [src/ObjectFactory.ts:32](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L32)
+Defined in: [src/ObjectFactory.ts:35](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L35)
 
 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:35](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L35)
+Defined in: [src/ObjectFactory.ts:38](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L38)
 
 The application logging utility.
 
@@ -84,7 +84,7 @@ The application logging utility.
 
 > **clear**(): `void`
 
-Defined in: [src/ObjectFactory.ts:104](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L104)
+Defined in: [src/ObjectFactory.ts:107](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L107)
 
 Deletes all instantiated objects.
 
@@ -98,7 +98,7 @@ Deletes all instantiated objects.
 
 > **clearAll**(): `void`
 
-Defined in: [src/ObjectFactory.ts:111](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L111)
+Defined in: [src/ObjectFactory.ts:114](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L114)
 
 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:47](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L47)
+Defined in: [src/ObjectFactory.ts:50](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L50)
 
 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:186](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L186)
+Defined in: [src/ObjectFactory.ts:215](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L215)
 
 Searches an object for one or more functions that implement a `@Init` decorator.
 
@@ -156,10 +156,10 @@ The list of functions that implements the `@Init` decorator if found, otherwise
 
 > **getInstance**\<`T`\>(`nameOrType`): `T` \| `undefined`
 
-Defined in: [src/ObjectFactory.ts:220](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L220)
+Defined in: [src/ObjectFactory.ts:249](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L249)
 
-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`
+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`
 instance or the first found instance of the given type.
 
 #### Type Parameters
@@ -186,9 +186,9 @@ The object instance associated with the given name if found, otherwise `undefine
 
 ### initialize()
 
-> **initialize**\<`T`\>(`obj`): `Promise`\<`T`\>
+> **initialize**\<`T`\>(`obj`): `T` \| `Promise`\<`T`\>
 
-Defined in: [src/ObjectFactory.ts:120](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L120)
+Defined in: [src/ObjectFactory.ts:123](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L123)
 
 Scans the given object for any properties with the `@Inject` decorator and assigns the correct values.
 
@@ -208,7 +208,7 @@ The object to initialize with injected defaults
 
 #### Returns
 
-`Promise`\<`T`\>
+`T` \| `Promise`\<`T`\>
 
 ***
 
@@ -216,10 +216,10 @@ The object to initialize with injected defaults
 
 > **newInstance**\<`T`\>(`type`, `options?`): `T` \| `Promise`\<`T`\>
 
-Defined in: [src/ObjectFactory.ts:265](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L265)
+Defined in: [src/ObjectFactory.ts:292](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L292)
 
-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
+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
 using the provided arguments.
 
 #### Type Parameters
@@ -234,13 +234,15 @@ using the provided arguments.
 
 `any`
 
-The fully qualified name or type of the class to instantiate. If a type is given it's class name will be inferred
+The fully qualified name or type of the class to instantiate. If a type is given it's class name will be inferred
 via the constructor name.
 
 ##### options?
 
 [`InstanceOptions`](../interfaces/InstanceOptions.md)
 
+The options to use when instantiating the new class object.
+
 #### Returns
 
 `T` \| `Promise`\<`T`\>
@@ -251,7 +253,7 @@ via the constructor name.
 
 > **register**(`clazz`, `fqn?`): `void`
 
-Defined in: [src/ObjectFactory.ts:336](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectFactory.ts#L336)
+Defined in: [src/ObjectFactory.ts:363](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ObjectFactory.ts#L363)
 
 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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectUtils.ts#L12)
+Defined in: [src/ObjectUtils.ts:12](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ObjectUtils.ts#L21)
+Defined in: [src/ObjectUtils.ts:21](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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.