@rapidrest/core 1.3.1 → 1.4.0

package/docs/reference/interfaces/SmtpConfig.md

@@ -1,41 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / SmtpConfig
-
-# Interface: SmtpConfig
-
-Defined in: [src/MessagingUtils.ts:59](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L59)
-
-## Properties
-
-### auth?
-
-> `optional` **auth?**: [`SmtpAuth`](SmtpAuth.md)
-
-Defined in: [src/MessagingUtils.ts:63](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L63)
-
-***
-
-### host
-
-> **host**: `string`
-
-Defined in: [src/MessagingUtils.ts:60](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L60)
-
-***
-
-### port
-
-> **port**: `number`
-
-Defined in: [src/MessagingUtils.ts:61](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L61)
-
-***
-
-### secure
-
-> **secure**: `boolean`
-
-Defined in: [src/MessagingUtils.ts:62](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L62)

package/docs/reference/interfaces/Template.md

@@ -1,105 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / Template
-
-# Interface: Template
-
-Defined in: [src/MessagingUtils.ts:21](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L21)
-
-## Properties
-
-### email\_options?
-
-> `optional` **email\_options?**: `any`
-
-Defined in: [src/MessagingUtils.ts:27](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L27)
-
-***
-
-### enabled
-
-> **enabled**: `boolean`
-
-Defined in: [src/MessagingUtils.ts:23](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L23)
-
-***
-
-### html?
-
-> `optional` **html?**: `string`
-
-Defined in: [src/MessagingUtils.ts:31](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L31)
-
-***
-
-### htmlPath?
-
-> `optional` **htmlPath?**: `string`
-
-Defined in: [src/MessagingUtils.ts:33](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L33)
-
-***
-
-### loaded?
-
-> `optional` **loaded?**: `boolean`
-
-Defined in: [src/MessagingUtils.ts:25](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L25)
-
-***
-
-### slack\_channel?
-
-> `optional` **slack\_channel?**: `string`
-
-Defined in: [src/MessagingUtils.ts:35](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L35)
-
-***
-
-### slack\_text?
-
-> `optional` **slack\_text?**: `string`
-
-Defined in: [src/MessagingUtils.ts:37](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L37)
-
-***
-
-### sms?
-
-> `optional` **sms?**: `string`
-
-Defined in: [src/MessagingUtils.ts:39](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L39)
-
-***
-
-### sms\_options?
-
-> `optional` **sms\_options?**: `any`
-
-Defined in: [src/MessagingUtils.ts:41](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L41)
-
-***
-
-### subject?
-
-> `optional` **subject?**: `string`
-
-Defined in: [src/MessagingUtils.ts:29](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L29)
-
-***
-
-### text?
-
-> `optional` **text?**: `string`
-
-Defined in: [src/MessagingUtils.ts:43](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L43)
-
-***
-
-### textPath?
-
-> `optional` **textPath?**: `string`
-
-Defined in: [src/MessagingUtils.ts:45](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L45)

package/docs/reference/interfaces/TemplateMapBase.md

@@ -1,13 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / TemplateMapBase
-
-# Interface: TemplateMapBase
-
-Defined in: [src/MessagingUtils.ts:13](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L13)
-
-## Indexable
-
-> \[`name`: `string`\]: [`Template`](Template.md)

package/docs/reference/interfaces/TwilioConfig.md

@@ -1,33 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / TwilioConfig
-
-# Interface: TwilioConfig
-
-Defined in: [src/MessagingUtils.ts:66](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L66)
-
-## Properties
-
-### accountSid
-
-> **accountSid**: `string`
-
-Defined in: [src/MessagingUtils.ts:67](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L67)
-
-***
-
-### options?
-
-> `optional` **options?**: `any`
-
-Defined in: [src/MessagingUtils.ts:69](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L69)
-
-***
-
-### token
-
-> **token**: `string`
-
-Defined in: [src/MessagingUtils.ts:68](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L68)

package/docs/reference/interfaces/WorkerMessage.md

@@ -1,31 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / WorkerMessage
-
-# Interface: WorkerMessage
-
-Defined in: [src/threads/ThreadWorker.ts:17](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadWorker.ts#L17)
-
-Describes a single message sent from the thread pool managger to a worker thread.
-
-## Properties
-
-### data?
-
-> `optional` **data?**: `any`
-
-Defined in: [src/threads/ThreadWorker.ts:19](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadWorker.ts#L19)
-
-The data associated with the message.
-
-***
-
-### type
-
-> **type**: [`WorkerMessageType`](../enumerations/WorkerMessageType.md)
-
-Defined in: [src/threads/ThreadWorker.ts:21](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadWorker.ts#L21)
-
-The type of message sent.

package/docs/reference/interfaces/WorkerOptions.md

@@ -1,61 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / WorkerOptions
-
-# Interface: WorkerOptions
-
-Defined in: [src/threads/ThreadPool.ts:25](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadPool.ts#L25)
-
-Describes the various options that can be used when creating worker threads.
-
-## Properties
-
-### allowTs?
-
-> `optional` **allowTs?**: `boolean`
-
-Defined in: [src/threads/ThreadPool.ts:33](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadPool.ts#L33)
-
-Set to `true` to enable support for importing TypeScript modules in the worker. Default is `true`.
-
-***
-
-### args?
-
-> `optional` **args?**: `any`
-
-Defined in: [src/threads/ThreadPool.ts:27](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadPool.ts#L27)
-
-The list of initialization arguments to pass into the worker thread.
-
-***
-
-### entry?
-
-> `optional` **entry?**: `string`
-
-Defined in: [src/threads/ThreadPool.ts:29](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadPool.ts#L29)
-
-The path to the entry file create a worker thread from. Default is `ThreadWorkerEntry.js`.
-
-***
-
-### restartOnExit?
-
-> `optional` **restartOnExit?**: `boolean`
-
-Defined in: [src/threads/ThreadPool.ts:31](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadPool.ts#L31)
-
-Indicates if a worker thread should automatically be restarted on exit.
-
-***
-
-### worker?
-
-> `optional` **worker?**: `string`
-
-Defined in: [src/threads/ThreadPool.ts:35](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadPool.ts#L35)
-
-The path to the worker file. This must be set when using `ThreadWorkerEntry` as the default entry file.

package/docs/reference/type-aliases/BooleanFunc.md

@@ -1,23 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / BooleanFunc
-
-# Type Alias: BooleanFunc
-
-> **BooleanFunc** = (`val`) => `boolean`
-
-Defined in: [src/ValidationUtils.ts:9](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L9)
-
-A simple validation function that returns a boolean success or fail.
-
-## Parameters
-
-### val
-
-`any`
-
-## Returns
-
-`boolean`

package/docs/reference/type-aliases/TemplateMap.md

@@ -1,17 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / TemplateMap
-
-# Type Alias: TemplateMap
-
-> **TemplateMap** = `Omit`\<[`TemplateMapBase`](../interfaces/TemplateMapBase.md), `"from"`\> & `object`
-
-Defined in: [src/MessagingUtils.ts:17](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/MessagingUtils.ts#L17)
-
-## Type Declaration
-
-### from
-
-> **from**: [`OriginSettings`](../interfaces/OriginSettings.md)

package/docs/reference/type-aliases/WorkerCallback.md

@@ -1,31 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / WorkerCallback
-
-# Type Alias: WorkerCallback
-
-> **WorkerCallback** = (`threadId`, `msg?`) => `void`
-
-Defined in: [src/threads/ThreadPool.ts:20](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadPool.ts#L20)
-
-Callback function for `ThreadPool` events.
-
-## Parameters
-
-### threadId
-
-`number`
-
-The id of the thread that originated the event.
-
-### msg?
-
-`any`
-
-The optional message data associated with the event.
-
-## Returns
-
-`void`

package/docs/reference/variables/Logger.md

@@ -1,25 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / Logger
-
-# Variable: Logger
-
-> `const` **Logger**: `any`
-
-Defined in: [src/Logger.ts:19](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/Logger.ts#L19)
-
-Creates (or retrieves a cached) logger with the specified level and file name to output logs to.
-
-## Param
-
-**level**
-
-The logging level to create the logger with.
-
-## Param
-
-**file**
-
-The name (without an extension) of the file to output logs to.