@rapidrest/core 1.3.1 → 1.4.0

package/docs/reference/classes/ValidationUtils.md

@@ -1,294 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / ValidationUtils
-
-# Class: ValidationUtils
-
-Defined in: [src/ValidationUtils.ts:14](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L14)
-
-A collection of validation functions to use with the `@Validator()` decorator.
-
-## Constructors
-
-### Constructor
-
-> **new ValidationUtils**(): `ValidationUtils`
-
-#### Returns
-
-`ValidationUtils`
-
-## Methods
-
-### check()
-
-> `static` **check**(`val`, `func`): `any`
-
-Defined in: [src/ValidationUtils.ts:23](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L23)
-
-A simple wrapper that calls the specified boolean validation function with the given value and returns the
-value as a result if the validation function passes. Otherwise throws an error.
-
-#### Parameters
-
-##### val
-
-`any`
-
-The value to validate.
-
-##### func
-
-[`BooleanFunc`](../type-aliases/BooleanFunc.md)
-
-The boolean validation function to check the value.
-
-#### Returns
-
-`any`
-
-#### Throws
-
-Throws an error if the value fails the boolean validation test.
-
-***
-
-### checkDate()
-
-> `static` **checkDate**(`val`): `string`
-
-Defined in: [src/ValidationUtils.ts:33](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L33)
-
-Validates that the provided string represents a ISO, RFC or UTC date or timestamp.
-
-#### Parameters
-
-##### val
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### checkEmail()
-
-> `static` **checkEmail**(`val`): `string`
-
-Defined in: [src/ValidationUtils.ts:43](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L43)
-
-Validates that the provided string represents a valid e-mail address.
-
-#### Parameters
-
-##### val
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### checkEmpty()
-
-> `static` **checkEmpty**(`val`): `any`[]
-
-Defined in: [src/ValidationUtils.ts:53](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L53)
-
-Validates that the provided array is not empty.
-
-#### Parameters
-
-##### val
-
-`any`[]
-
-#### Returns
-
-`any`[]
-
-***
-
-### checkIP()
-
-> `static` **checkIP**(`val`): `string`
-
-Defined in: [src/ValidationUtils.ts:63](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L63)
-
-Validates that the provided string is a valid IP address.
-
-#### Parameters
-
-##### val
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### checkJSON()
-
-> `static` **checkJSON**(`val`): `string`
-
-Defined in: [src/ValidationUtils.ts:73](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L73)
-
-Validates that the provided string is valid JSON (note: uses `JSON.parse`).
-
-#### Parameters
-
-##### val
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### checkName()
-
-> `static` **checkName**(`val`): `string`
-
-Defined in: [src/ValidationUtils.ts:83](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L83)
-
-Validates that the provided string matches the regexp pattern /[a-zA-Z0-9_\-\.@:\+]+/.
-
-#### Parameters
-
-##### val
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### checkNull()
-
-> `static` **checkNull**(`val`): `any`
-
-Defined in: [src/ValidationUtils.ts:93](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L93)
-
-Validates that the provided object is not null or empty.
-
-#### Parameters
-
-##### val
-
-`any`
-
-#### Returns
-
-`any`
-
-***
-
-### checkPhone()
-
-> `static` **checkPhone**(`val`): `string`
-
-Defined in: [src/ValidationUtils.ts:103](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L103)
-
-Validates that the provided string represents a valid phone number.
-
-#### Parameters
-
-##### val
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### checkSemVer()
-
-> `static` **checkSemVer**(`val`): `string`
-
-Defined in: [src/ValidationUtils.ts:113](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L113)
-
-Validates that the provided string represents a semantic version.
-
-#### Parameters
-
-##### val
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### checkURL()
-
-> `static` **checkURL**(`val`): `string`
-
-Defined in: [src/ValidationUtils.ts:123](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L123)
-
-Validates that the provided string is a valid URL.
-
-#### Parameters
-
-##### val
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### checkUUID()
-
-> `static` **checkUUID**(`val`): `string`
-
-Defined in: [src/ValidationUtils.ts:133](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L133)
-
-Validates that the provided string is a valid UUID.
-
-#### Parameters
-
-##### val
-
-`string`
-
-#### Returns
-
-`string`
-
-***
-
-### checkVersion()
-
-> `static` **checkVersion**(`val`): `number`
-
-Defined in: [src/ValidationUtils.ts:143](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ValidationUtils.ts#L143)
-
-Validates that the provided value is an entity `version` number (e.g. `value > 0`).
-
-#### Parameters
-
-##### val
-
-`any`
-
-#### Returns
-
-`number`

package/docs/reference/enumerations/AlertPriority.md

@@ -1,61 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / AlertPriority
-
-# Enumeration: AlertPriority
-
-Defined in: [src/AlertUtils.ts:24](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L24)
-
-Describes the level of priority for a given alert and an importance for triaging the problem.
-
-## Enumeration Members
-
-### Critical
-
-> **Critical**: `"P1"`
-
-Defined in: [src/AlertUtils.ts:26](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L26)
-
-Describes an alert that affects critical operating functionality or infrastructure.
-
-***
-
-### Important
-
-> **Important**: `"P3"`
-
-Defined in: [src/AlertUtils.ts:30](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L30)
-
-Describes an alert that affects basic systems that may create a poor end-user experience.
-
-***
-
-### Notice
-
-> **Notice**: `"P5"`
-
-Defined in: [src/AlertUtils.ts:34](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L34)
-
-Describes an alert that has no material affect on end-user experience and no potential for escalation.
-
-***
-
-### Severe
-
-> **Severe**: `"P2"`
-
-Defined in: [src/AlertUtils.ts:28](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L28)
-
-Describes an alert that affects key systems that have great impact on end-user experiences.
-
-***
-
-### Warning
-
-> **Warning**: `"P4"`
-
-Defined in: [src/AlertUtils.ts:32](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L32)
-
-Describes an alert that has no material affect on the end-user experience but with potential to escalate.

package/docs/reference/enumerations/JWTUtilsCompressionMethods.md

@@ -1,21 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / JWTUtilsCompressionMethods
-
-# Enumeration: JWTUtilsCompressionMethods
-
-Defined in: [src/JWTUtils.ts:55](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L55)
-
-Describes the different types of support compression methods for JWT payloads.
-
-## Enumeration Members
-
-### ZLIB
-
-> **ZLIB**: `"zlib"`
-
-Defined in: [src/JWTUtils.ts:57](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/JWTUtils.ts#L57)
-
-Uses the zlib compression method.

package/docs/reference/enumerations/WorkerMessageType.md

@@ -1,43 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / WorkerMessageType
-
-# Enumeration: WorkerMessageType
-
-Defined in: [src/threads/ThreadWorker.ts:7](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadWorker.ts#L7)
-
-Describes the types of messages passed between the parent thread pool manager and a worker thread.
-
-## Enumeration Members
-
-### ERROR
-
-> **ERROR**: `"_WorkerError"`
-
-Defined in: [src/threads/ThreadWorker.ts:8](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadWorker.ts#L8)
-
-***
-
-### LOG
-
-> **LOG**: `"_WorkerLog"`
-
-Defined in: [src/threads/ThreadWorker.ts:9](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadWorker.ts#L9)
-
-***
-
-### ONLINE
-
-> **ONLINE**: `"_WorkerOnline"`
-
-Defined in: [src/threads/ThreadWorker.ts:10](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadWorker.ts#L10)
-
-***
-
-### STOP
-
-> **STOP**: `"_StopWorker"`
-
-Defined in: [src/threads/ThreadWorker.ts:11](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/threads/ThreadWorker.ts#L11)

package/docs/reference/functions/sleep.md

@@ -1,25 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / sleep
-
-# Function: sleep()
-
-> **sleep**(`ms?`): `Promise`\<`void`\>
-
-Defined in: [src/sleep.ts:8](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/sleep.ts#L8)
-
-Starts a timer to suspend execution for a given number of milliseconds.
-
-## Parameters
-
-### ms?
-
-`number` = `1`
-
-The number of milliseconds to suspend. Default is `1`.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/reference/globals.md

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

package/docs/reference/interfaces/Alert.md

@@ -1,101 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / Alert
-
-# Interface: Alert
-
-Defined in: [src/AlertUtils.ts:40](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L40)
-
-Describes a single system failure or other similar critical event that requires immediate attention.
-
-## Properties
-
-### alias
-
-> **alias**: `string`
-
-Defined in: [src/AlertUtils.ts:42](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L42)
-
-The name of the alert that uniquely identifies the report for purposes of de-duplication.
-
-***
-
-### description
-
-> **description**: `string`
-
-Defined in: [src/AlertUtils.ts:44](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L44)
-
-The detailed information about the event that has occurred.
-
-***
-
-### details?
-
-> `optional` **details?**: `any`
-
-Defined in: [src/AlertUtils.ts:46](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L46)
-
-A key-value map of custom information about the alert.
-
-***
-
-### entity?
-
-> `optional` **entity?**: `string`
-
-Defined in: [src/AlertUtils.ts:48](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L48)
-
-Used to specify a category or problem domain for filtering.
-
-***
-
-### message
-
-> **message**: `string`
-
-Defined in: [src/AlertUtils.ts:50](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L50)
-
-The basic summary of the alert that describes the event.
-
-***
-
-### note?
-
-> `optional` **note?**: `string`
-
-Defined in: [src/AlertUtils.ts:52](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L52)
-
-Additional detail about the event.
-
-***
-
-### priority
-
-> **priority**: [`AlertPriority`](../enumerations/AlertPriority.md)
-
-Defined in: [src/AlertUtils.ts:54](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L54)
-
-The priority level of the alert.
-
-***
-
-### source
-
-> **source**: `string`
-
-Defined in: [src/AlertUtils.ts:56](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L56)
-
-The source of the alert. Can be a pod/service name, IP address or other unique identifier.
-
-***
-
-### tags?
-
-> `optional` **tags?**: `string`[]
-
-Defined in: [src/AlertUtils.ts:58](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L58)
-
-A list of unique tags to associate with the event.

package/docs/reference/interfaces/AlertAttachment.md

@@ -1,51 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / AlertAttachment
-
-# Interface: AlertAttachment
-
-Defined in: [src/AlertUtils.ts:64](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L64)
-
-Describes a single attachment that can be added to an alert.
-
-## Properties
-
-### contentType
-
-> **contentType**: `string`
-
-Defined in: [src/AlertUtils.ts:66](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L66)
-
-The content-type of the attachment.
-
-***
-
-### data
-
-> **data**: `Buffer`\<`ArrayBufferLike`\> \| `ReadStream`
-
-Defined in: [src/AlertUtils.ts:68](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L68)
-
-The contents of the attachment.
-
-***
-
-### filename
-
-> **filename**: `string`
-
-Defined in: [src/AlertUtils.ts:70](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L70)
-
-The name of the attachment.
-
-***
-
-### size?
-
-> `optional` **size?**: `number`
-
-Defined in: [src/AlertUtils.ts:72](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L72)
-
-The size of the attachment.

package/docs/reference/interfaces/AlertClose.md

@@ -1,31 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / AlertClose
-
-# Interface: AlertClose
-
-Defined in: [src/AlertUtils.ts:78](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L78)
-
-Describes a request to close an alert.
-
-## Properties
-
-### note?
-
-> `optional` **note?**: `string`
-
-Defined in: [src/AlertUtils.ts:82](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L82)
-
-Additional alert note to add.
-
-***
-
-### source?
-
-> `optional` **source?**: `string`
-
-Defined in: [src/AlertUtils.ts:80](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L80)
-
-Display name of the request source.