@rapidrest/core 1.1.4 → 1.2.0

package/docs/reference/classes/ApiError.md

@@ -6,7 +6,7 @@
 
 # Class: ApiError
 
-Defined in: [src/ApiError.ts:8](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ApiError.ts#L8)
+Defined in: [src/ApiError.ts:8](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ApiError.ts#L8)
 
 Describes an error that originates from a API service. This class extends the standard `Error` class to include
 a unique code that can be used to trace an error to source code as well as the HTTP response status returned with
@@ -22,7 +22,7 @@ the error.
 
 > **new ApiError**(`code`, `status`, `message?`, `templateVariables?`): `ApiError`
 
-Defined in: [src/ApiError.ts:24](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ApiError.ts#L24)
+Defined in: [src/ApiError.ts:24](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ApiError.ts#L24)
 
 #### Parameters
 
@@ -52,23 +52,11 @@ Defined in: [src/ApiError.ts:24](https://github.com/rapidrest/core/blob/23a4f312
 
 ## Properties
 
-### cause?
-
-> `optional` **cause**: `unknown`
-
-Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
-
-#### Inherited from
-
-`Error.cause`
-
-***
-
 ### code
 
 > **code**: `string`
 
-Defined in: [src/ApiError.ts:10](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ApiError.ts#L10)
+Defined in: [src/ApiError.ts:10](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ApiError.ts#L10)
 
 The unique code of the error.
 
@@ -78,7 +66,7 @@ The unique code of the error.
 
 > **message**: `string`
 
-Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1075
 
 #### Inherited from
 
@@ -90,7 +78,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077
 
 > **name**: `string`
 
-Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1074
 
 #### Inherited from
 
@@ -100,9 +88,9 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
 
 ### stack?
 
-> `optional` **stack**: `string`
+> `optional` **stack?**: `string`
 
-Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
 
 #### Inherited from
 
@@ -114,7 +102,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
 
 > **status**: `number`
 
-Defined in: [src/ApiError.ts:12](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ApiError.ts#L12)
+Defined in: [src/ApiError.ts:12](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ApiError.ts#L12)
 
 The HTTP status associated with the error.
 
@@ -146,13 +134,13 @@ not capture any frames.
 
 > **ApiMessageTemplate**(`message`, `templateVariables?`): `string`
 
-Defined in: [src/ApiError.ts:14](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ApiError.ts#L14)
+Defined in: [src/ApiError.ts:14](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ApiError.ts#L14)
 
 #### Parameters
 
 ##### message
 
-`string` | `undefined`
+`string` \| `undefined`
 
 ##### templateVariables?
 

package/docs/reference/classes/ClassLoader.md

@@ -6,7 +6,7 @@
 
 # Class: ClassLoader
 
-Defined in: [src/ClassLoader.ts:48](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ClassLoader.ts#L48)
+Defined in: [src/ClassLoader.ts:48](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L48)
 
 The *ClassLoader* provides a container for dynamically loading classes at runtime using C#/Java style namespaces.
 Namespaces are determined from the folder structure relative to the root.
@@ -55,9 +55,9 @@ Jean-Philippe Steinmetz
 
 ### Constructor
 
-> **new ClassLoader**(`rootDir`, `includeJavaScript`, `includeTypeScript`, `ignore`): `ClassLoader`
+> **new ClassLoader**(`rootDir`, `includeJavaScript?`, `includeTypeScript?`, `ignore?`): `ClassLoader`
 
-Defined in: [src/ClassLoader.ts:67](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ClassLoader.ts#L67)
+Defined in: [src/ClassLoader.ts:67](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L67)
 
 Creates a new instance of `ClassLoader` with the specified defaults.
 
@@ -69,18 +69,18 @@ Creates a new instance of `ClassLoader` with the specified defaults.
 
 The root directory to load all classes from.
 
-##### includeJavaScript
+##### includeJavaScript?
 
 `boolean` = `true`
 
 Set to `true` to load all TypeScript classes from the given `rootDir`, otherwise set to `false.
 @param includeTypeScript Set to `true` to load all JavaScript classes from the given `rootDir`, otherwise set to `false.
 
-##### includeTypeScript
+##### includeTypeScript?
 
 `boolean` = `true`
 
-##### ignore
+##### ignore?
 
 (`string` \| `RegExp`)[] = `[]`
 
@@ -96,7 +96,7 @@ A list of regex pattern of file paths to ignore.
 
 > `protected` **classes**: `Map`\<`string`, `any`\>
 
-Defined in: [src/ClassLoader.ts:50](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ClassLoader.ts#L50)
+Defined in: [src/ClassLoader.ts:50](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L50)
 
 The map containnig all loaded classes.
 
@@ -106,7 +106,7 @@ The map containnig all loaded classes.
 
 > `protected` **ignore**: (`string` \| `RegExp`)[] = `[]`
 
-Defined in: [src/ClassLoader.ts:51](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ClassLoader.ts#L51)
+Defined in: [src/ClassLoader.ts:51](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L51)
 
 ***
 
@@ -114,7 +114,7 @@ Defined in: [src/ClassLoader.ts:51](https://github.com/rapidrest/core/blob/23a4f
 
 > `protected` **includeJavaScript**: `boolean` = `true`
 
-Defined in: [src/ClassLoader.ts:55](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ClassLoader.ts#L55)
+Defined in: [src/ClassLoader.ts:55](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L55)
 
 Indicates if JavaScript classes should be loaded.
 
@@ -124,7 +124,7 @@ Indicates if JavaScript classes should be loaded.
 
 > `protected` **includeTypeScript**: `boolean` = `true`
 
-Defined in: [src/ClassLoader.ts:53](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ClassLoader.ts#L53)
+Defined in: [src/ClassLoader.ts:53](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L53)
 
 Indicates if TypeScript classes should be loaded.
 
@@ -134,7 +134,7 @@ Indicates if TypeScript classes should be loaded.
 
 > `protected` **rootDir**: `string` = `"."`
 
-Defined in: [src/ClassLoader.ts:57](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ClassLoader.ts#L57)
+Defined in: [src/ClassLoader.ts:57](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L57)
 
 The path to the root directory containing all classes on disk.
 
@@ -144,7 +144,7 @@ The path to the root directory containing all classes on disk.
 
 > **getClass**(`fqn`): `any`
 
-Defined in: [src/ClassLoader.ts:80](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ClassLoader.ts#L80)
+Defined in: [src/ClassLoader.ts:80](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L80)
 
 Returns the class with the specified fully qualified name.
 
@@ -168,7 +168,7 @@ The class definition for the given fully qualified name if found, otherwise `und
 
 > **getClasses**(): `Map`\<`string`, `any`\>
 
-Defined in: [src/ClassLoader.ts:87](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ClassLoader.ts#L87)
+Defined in: [src/ClassLoader.ts:87](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L87)
 
 Returns the map containing all classes that have been loaded.
 
@@ -182,7 +182,7 @@ Returns the map containing all classes that have been loaded.
 
 > **hasClass**(`fqn`): `any`
 
-Defined in: [src/ClassLoader.ts:97](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ClassLoader.ts#L97)
+Defined in: [src/ClassLoader.ts:97](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L97)
 
 Returns `true` if a class exists with the specified fully qualified name.
 
@@ -204,16 +204,16 @@ The fully qualified name of the class to search.
 
 ### load()
 
-> **load**(`dir`): `Promise`\<`void`\>
+> **load**(`dir?`): `Promise`\<`void`\>
 
-Defined in: [src/ClassLoader.ts:107](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ClassLoader.ts#L107)
+Defined in: [src/ClassLoader.ts:107](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ClassLoader.ts#L107)
 
 Loads all modules exports contained in the directory specified. The folder must be a child
 directory to the `rootDir` parameter passed in to the constructor.
 
 #### Parameters
 
-##### dir
+##### dir?
 
 `string` = `""`
 

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.