@rapidrest/core 1.0.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/{README.rst → README.md} +5 -11
- package/dist/lib/FileUtils.js +9 -9
- package/dist/lib/FileUtils.js.map +1 -1
- package/dist/lib/Logger.js +1 -1
- package/dist/lib/Logger.js.map +1 -1
- package/dist/lib/MessagingUtils.js +28 -13
- package/dist/lib/MessagingUtils.js.map +1 -1
- package/dist/lib/ObjectFactory.js +2 -2
- package/dist/lib/ObjectFactory.js.map +1 -1
- package/dist/lib/TelemetryUtils.js +2 -2
- package/dist/lib/TelemetryUtils.js.map +1 -1
- package/dist/types/MessagingUtils.d.ts +8 -0
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/README.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Config.md +2 -2
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Destroy.md +2 -2
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Init.md +2 -2
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Inject.md +2 -2
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Logger.md +2 -2
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Nullable.md +2 -2
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Validator.md +2 -2
- package/docs/reference/@rapidrest/namespaces/ObjectDecorators/type-aliases/ValidatorFunction.md +2 -2
- package/docs/reference/README.md +23 -61
- package/docs/reference/classes/AlertUtils.md +7 -7
- package/docs/reference/classes/ApiError.md +6 -6
- package/docs/reference/classes/ClassLoader.md +12 -12
- package/docs/reference/classes/Event.md +9 -9
- package/docs/reference/classes/EventUtils.md +5 -5
- package/docs/reference/classes/FileUtils.md +6 -6
- package/docs/reference/classes/JWTUtils.md +4 -4
- package/docs/reference/classes/MessagingUtils.md +30 -8
- package/docs/reference/classes/OASUtils.md +9 -9
- package/docs/reference/classes/ObjectFactory.md +15 -15
- package/docs/reference/classes/ObjectUtils.md +3 -3
- package/docs/reference/classes/StringUtils.md +7 -7
- package/docs/reference/classes/ThreadPool.md +12 -12
- package/docs/reference/classes/ThreadWorker.md +7 -7
- package/docs/reference/classes/UserUtils.md +9 -9
- package/docs/reference/classes/ValidationUtils.md +15 -15
- package/docs/reference/enumerations/AlertPriority.md +7 -7
- package/docs/reference/enumerations/JWTUtilsCompressionMethods.md +3 -3
- package/docs/reference/enumerations/WorkerMessageType.md +6 -6
- package/docs/reference/functions/sleep.md +2 -2
- package/docs/reference/globals.md +73 -0
- package/docs/reference/interfaces/Alert.md +11 -11
- package/docs/reference/interfaces/AlertAttachment.md +6 -6
- package/docs/reference/interfaces/AlertClose.md +4 -4
- package/docs/reference/interfaces/AlertUtilsAttachmentOptions.md +5 -5
- package/docs/reference/interfaces/AlertUtilsOptions.md +5 -5
- package/docs/reference/interfaces/InstanceOptions.md +5 -5
- package/docs/reference/interfaces/JWTPayload.md +6 -6
- package/docs/reference/interfaces/JWTUser.md +6 -6
- package/docs/reference/interfaces/JWTUtilsConfig.md +5 -5
- package/docs/reference/interfaces/JWTUtilsPayloadKeyOptions.md +6 -6
- package/docs/reference/interfaces/JWTUtilsPayloadOptions.md +4 -4
- package/docs/reference/interfaces/JWTUtilsPayloadPasswordOptions.md +7 -7
- package/docs/reference/interfaces/NewEvent.md +3 -3
- package/docs/reference/interfaces/OriginSettings.md +4 -4
- package/docs/reference/interfaces/SlackConfig.md +5 -5
- package/docs/reference/interfaces/SmtpAuth.md +4 -4
- package/docs/reference/interfaces/SmtpConfig.md +6 -6
- package/docs/reference/interfaces/Template.md +35 -11
- package/docs/reference/interfaces/TemplateMapBase.md +2 -2
- package/docs/reference/interfaces/TwilioConfig.md +5 -5
- package/docs/reference/interfaces/WorkerMessage.md +4 -4
- package/docs/reference/interfaces/WorkerOptions.md +7 -7
- package/docs/reference/type-aliases/BooleanFunc.md +2 -2
- package/docs/reference/type-aliases/TemplateMap.md +2 -2
- package/docs/reference/type-aliases/WorkerCallback.md +2 -2
- package/docs/reference/variables/Logger.md +2 -2
- package/package.json +96 -96
- package/dist/lib/threads/ThreadLogger.js +0 -43
- package/dist/lib/threads/ThreadLogger.js.map +0 -1
- package/dist/lib/threads/ThreadWorkerEntry.js +0 -77
- package/dist/lib/threads/ThreadWorkerEntry.js.map +0 -1
- package/dist/types/threads/ThreadLogger.d.ts +0 -15
- package/dist/types/threads/ThreadWorkerEntry.d.ts +0 -1
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / JWTUtilsPayloadPasswordOptions
|
|
6
6
|
|
|
7
7
|
# Interface: JWTUtilsPayloadPasswordOptions
|
|
8
8
|
|
|
9
|
-
Defined in: src/JWTUtils.ts:83
|
|
9
|
+
Defined in: [src/JWTUtils.ts:83](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L83)
|
|
10
10
|
|
|
11
11
|
Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing password
|
|
12
12
|
based encryption.
|
|
@@ -25,7 +25,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
25
25
|
|
|
26
26
|
> **algorithm**: `string`
|
|
27
27
|
|
|
28
|
-
Defined in: src/JWTUtils.ts:87
|
|
28
|
+
Defined in: [src/JWTUtils.ts:87](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L87)
|
|
29
29
|
|
|
30
30
|
The cryptographic cipher algorithm to use during encryption/decryption of a JWT token payload.
|
|
31
31
|
|
|
@@ -35,7 +35,7 @@ The cryptographic cipher algorithm to use during encryption/decryption of a JWT
|
|
|
35
35
|
|
|
36
36
|
> `optional` **compress**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
|
|
37
37
|
|
|
38
|
-
Defined in: src/JWTUtils.ts:69
|
|
38
|
+
Defined in: [src/JWTUtils.ts:69](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L69)
|
|
39
39
|
|
|
40
40
|
Set the method to use for compressing the payload profile, otherwise set to `null` for no compression.
|
|
41
41
|
|
|
@@ -49,7 +49,7 @@ Set the method to use for compressing the payload profile, otherwise set to `nul
|
|
|
49
49
|
|
|
50
50
|
> `optional` **encrypt**: `boolean`
|
|
51
51
|
|
|
52
|
-
Defined in: src/JWTUtils.ts:74
|
|
52
|
+
Defined in: [src/JWTUtils.ts:74](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L74)
|
|
53
53
|
|
|
54
54
|
Set to `true` to indicate that the JWT token payload is encrypted, otherwise set to `false`.
|
|
55
55
|
|
|
@@ -63,7 +63,7 @@ Set to `true` to indicate that the JWT token payload is encrypted, otherwise set
|
|
|
63
63
|
|
|
64
64
|
> **iv**: `Buffer`
|
|
65
65
|
|
|
66
|
-
Defined in: src/JWTUtils.ts:92
|
|
66
|
+
Defined in: [src/JWTUtils.ts:92](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L92)
|
|
67
67
|
|
|
68
68
|
The initialization vector to use during encryption and decryption.
|
|
69
69
|
|
|
@@ -73,6 +73,6 @@ The initialization vector to use during encryption and decryption.
|
|
|
73
73
|
|
|
74
74
|
> **password**: `string`
|
|
75
75
|
|
|
76
|
-
Defined in: src/JWTUtils.ts:97
|
|
76
|
+
Defined in: [src/JWTUtils.ts:97](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/JWTUtils.ts#L97)
|
|
77
77
|
|
|
78
78
|
The password to use when encrypting or decrypting JWT token payloads.
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / NewEvent
|
|
6
6
|
|
|
7
7
|
# Interface: NewEvent
|
|
8
8
|
|
|
9
|
-
Defined in: src/TelemetryUtils.ts:13
|
|
9
|
+
Defined in: [src/TelemetryUtils.ts:13](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L13)
|
|
10
10
|
|
|
11
11
|
Describes the required fields when creating a new telemetry event.
|
|
12
12
|
|
|
@@ -20,6 +20,6 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
20
20
|
|
|
21
21
|
> **type**: `string`
|
|
22
22
|
|
|
23
|
-
Defined in: src/TelemetryUtils.ts:15
|
|
23
|
+
Defined in: [src/TelemetryUtils.ts:15](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L15)
|
|
24
24
|
|
|
25
25
|
The type of event begin recorded.
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / OriginSettings
|
|
6
6
|
|
|
7
7
|
# Interface: OriginSettings
|
|
8
8
|
|
|
9
|
-
Defined in: src/MessagingUtils.ts:
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:8](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L8)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: src/MessagingUtils.ts:7
|
|
|
14
14
|
|
|
15
15
|
> **email**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: src/MessagingUtils.ts:
|
|
17
|
+
Defined in: [src/MessagingUtils.ts:9](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L9)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,4 +22,4 @@ Defined in: src/MessagingUtils.ts:8
|
|
|
22
22
|
|
|
23
23
|
> **sms**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: src/MessagingUtils.ts:
|
|
25
|
+
Defined in: [src/MessagingUtils.ts:10](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L10)
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / SlackConfig
|
|
6
6
|
|
|
7
7
|
# Interface: SlackConfig
|
|
8
8
|
|
|
9
|
-
Defined in: src/MessagingUtils.ts:
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:48](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L48)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: src/MessagingUtils.ts:41
|
|
|
14
14
|
|
|
15
15
|
> **name**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: src/MessagingUtils.ts:
|
|
17
|
+
Defined in: [src/MessagingUtils.ts:49](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L49)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: src/MessagingUtils.ts:42
|
|
|
22
22
|
|
|
23
23
|
> **signingSecret**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: src/MessagingUtils.ts:
|
|
25
|
+
Defined in: [src/MessagingUtils.ts:51](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L51)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,4 +30,4 @@ Defined in: src/MessagingUtils.ts:44
|
|
|
30
30
|
|
|
31
31
|
> **token**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: src/MessagingUtils.ts:
|
|
33
|
+
Defined in: [src/MessagingUtils.ts:50](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L50)
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / SmtpAuth
|
|
6
6
|
|
|
7
7
|
# Interface: SmtpAuth
|
|
8
8
|
|
|
9
|
-
Defined in: src/MessagingUtils.ts:
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:54](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L54)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: src/MessagingUtils.ts:47
|
|
|
14
14
|
|
|
15
15
|
> **pass**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: src/MessagingUtils.ts:
|
|
17
|
+
Defined in: [src/MessagingUtils.ts:56](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L56)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,4 +22,4 @@ Defined in: src/MessagingUtils.ts:49
|
|
|
22
22
|
|
|
23
23
|
> **user**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: src/MessagingUtils.ts:
|
|
25
|
+
Defined in: [src/MessagingUtils.ts:55](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L55)
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / SmtpConfig
|
|
6
6
|
|
|
7
7
|
# Interface: SmtpConfig
|
|
8
8
|
|
|
9
|
-
Defined in: src/MessagingUtils.ts:
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:59](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L59)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: src/MessagingUtils.ts:52
|
|
|
14
14
|
|
|
15
15
|
> `optional` **auth**: [`SmtpAuth`](SmtpAuth.md)
|
|
16
16
|
|
|
17
|
-
Defined in: src/MessagingUtils.ts:
|
|
17
|
+
Defined in: [src/MessagingUtils.ts:63](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L63)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: src/MessagingUtils.ts:56
|
|
|
22
22
|
|
|
23
23
|
> **host**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: src/MessagingUtils.ts:
|
|
25
|
+
Defined in: [src/MessagingUtils.ts:60](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L60)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: src/MessagingUtils.ts:53
|
|
|
30
30
|
|
|
31
31
|
> **port**: `number`
|
|
32
32
|
|
|
33
|
-
Defined in: src/MessagingUtils.ts:
|
|
33
|
+
Defined in: [src/MessagingUtils.ts:61](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L61)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,4 +38,4 @@ Defined in: src/MessagingUtils.ts:54
|
|
|
38
38
|
|
|
39
39
|
> **secure**: `boolean`
|
|
40
40
|
|
|
41
|
-
Defined in: src/MessagingUtils.ts:
|
|
41
|
+
Defined in: [src/MessagingUtils.ts:62](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L62)
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / Template
|
|
6
6
|
|
|
7
7
|
# Interface: Template
|
|
8
8
|
|
|
9
|
-
Defined in: src/MessagingUtils.ts:
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:21](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L21)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: src/MessagingUtils.ts:20
|
|
|
14
14
|
|
|
15
15
|
> `optional` **email\_options**: `any`
|
|
16
16
|
|
|
17
|
-
Defined in: src/MessagingUtils.ts:
|
|
17
|
+
Defined in: [src/MessagingUtils.ts:27](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L27)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: src/MessagingUtils.ts:24
|
|
|
22
22
|
|
|
23
23
|
> **enabled**: `boolean`
|
|
24
24
|
|
|
25
|
-
Defined in: src/MessagingUtils.ts:
|
|
25
|
+
Defined in: [src/MessagingUtils.ts:23](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L23)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,23 @@ Defined in: src/MessagingUtils.ts:22
|
|
|
30
30
|
|
|
31
31
|
> `optional` **html**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: src/MessagingUtils.ts:
|
|
33
|
+
Defined in: [src/MessagingUtils.ts:31](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L31)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### htmlPath?
|
|
38
|
+
|
|
39
|
+
> `optional` **htmlPath**: `string`
|
|
40
|
+
|
|
41
|
+
Defined in: [src/MessagingUtils.ts:33](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L33)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### loaded?
|
|
46
|
+
|
|
47
|
+
> `optional` **loaded**: `boolean`
|
|
48
|
+
|
|
49
|
+
Defined in: [src/MessagingUtils.ts:25](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L25)
|
|
34
50
|
|
|
35
51
|
***
|
|
36
52
|
|
|
@@ -38,7 +54,7 @@ Defined in: src/MessagingUtils.ts:28
|
|
|
38
54
|
|
|
39
55
|
> `optional` **slack\_channel**: `string`
|
|
40
56
|
|
|
41
|
-
Defined in: src/MessagingUtils.ts:
|
|
57
|
+
Defined in: [src/MessagingUtils.ts:35](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L35)
|
|
42
58
|
|
|
43
59
|
***
|
|
44
60
|
|
|
@@ -46,7 +62,7 @@ Defined in: src/MessagingUtils.ts:30
|
|
|
46
62
|
|
|
47
63
|
> `optional` **slack\_text**: `string`
|
|
48
64
|
|
|
49
|
-
Defined in: src/MessagingUtils.ts:
|
|
65
|
+
Defined in: [src/MessagingUtils.ts:37](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L37)
|
|
50
66
|
|
|
51
67
|
***
|
|
52
68
|
|
|
@@ -54,7 +70,7 @@ Defined in: src/MessagingUtils.ts:32
|
|
|
54
70
|
|
|
55
71
|
> `optional` **sms**: `string`
|
|
56
72
|
|
|
57
|
-
Defined in: src/MessagingUtils.ts:
|
|
73
|
+
Defined in: [src/MessagingUtils.ts:39](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L39)
|
|
58
74
|
|
|
59
75
|
***
|
|
60
76
|
|
|
@@ -62,7 +78,7 @@ Defined in: src/MessagingUtils.ts:34
|
|
|
62
78
|
|
|
63
79
|
> `optional` **sms\_options**: `any`
|
|
64
80
|
|
|
65
|
-
Defined in: src/MessagingUtils.ts:
|
|
81
|
+
Defined in: [src/MessagingUtils.ts:41](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L41)
|
|
66
82
|
|
|
67
83
|
***
|
|
68
84
|
|
|
@@ -70,7 +86,7 @@ Defined in: src/MessagingUtils.ts:36
|
|
|
70
86
|
|
|
71
87
|
> `optional` **subject**: `string`
|
|
72
88
|
|
|
73
|
-
Defined in: src/MessagingUtils.ts:
|
|
89
|
+
Defined in: [src/MessagingUtils.ts:29](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L29)
|
|
74
90
|
|
|
75
91
|
***
|
|
76
92
|
|
|
@@ -78,4 +94,12 @@ Defined in: src/MessagingUtils.ts:26
|
|
|
78
94
|
|
|
79
95
|
> `optional` **text**: `string`
|
|
80
96
|
|
|
81
|
-
Defined in: src/MessagingUtils.ts:
|
|
97
|
+
Defined in: [src/MessagingUtils.ts:43](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L43)
|
|
98
|
+
|
|
99
|
+
***
|
|
100
|
+
|
|
101
|
+
### textPath?
|
|
102
|
+
|
|
103
|
+
> `optional` **textPath**: `string`
|
|
104
|
+
|
|
105
|
+
Defined in: [src/MessagingUtils.ts:45](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L45)
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / TemplateMapBase
|
|
6
6
|
|
|
7
7
|
# Interface: TemplateMapBase
|
|
8
8
|
|
|
9
|
-
Defined in: src/MessagingUtils.ts:
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:13](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L13)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / TwilioConfig
|
|
6
6
|
|
|
7
7
|
# Interface: TwilioConfig
|
|
8
8
|
|
|
9
|
-
Defined in: src/MessagingUtils.ts:
|
|
9
|
+
Defined in: [src/MessagingUtils.ts:66](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L66)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: src/MessagingUtils.ts:59
|
|
|
14
14
|
|
|
15
15
|
> **accountSid**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: src/MessagingUtils.ts:
|
|
17
|
+
Defined in: [src/MessagingUtils.ts:67](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L67)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: src/MessagingUtils.ts:60
|
|
|
22
22
|
|
|
23
23
|
> `optional` **options**: `any`
|
|
24
24
|
|
|
25
|
-
Defined in: src/MessagingUtils.ts:
|
|
25
|
+
Defined in: [src/MessagingUtils.ts:69](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L69)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,4 +30,4 @@ Defined in: src/MessagingUtils.ts:62
|
|
|
30
30
|
|
|
31
31
|
> **token**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: src/MessagingUtils.ts:
|
|
33
|
+
Defined in: [src/MessagingUtils.ts:68](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L68)
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / WorkerMessage
|
|
6
6
|
|
|
7
7
|
# Interface: WorkerMessage
|
|
8
8
|
|
|
9
|
-
Defined in: src/threads/ThreadWorker.ts:17
|
|
9
|
+
Defined in: [src/threads/ThreadWorker.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L17)
|
|
10
10
|
|
|
11
11
|
Describes a single message sent from the thread pool managger to a worker thread.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Describes a single message sent from the thread pool managger to a worker thread
|
|
|
16
16
|
|
|
17
17
|
> `optional` **data**: `any`
|
|
18
18
|
|
|
19
|
-
Defined in: src/threads/ThreadWorker.ts:19
|
|
19
|
+
Defined in: [src/threads/ThreadWorker.ts:19](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L19)
|
|
20
20
|
|
|
21
21
|
The data associated with the message.
|
|
22
22
|
|
|
@@ -26,6 +26,6 @@ The data associated with the message.
|
|
|
26
26
|
|
|
27
27
|
> **type**: [`WorkerMessageType`](../enumerations/WorkerMessageType.md)
|
|
28
28
|
|
|
29
|
-
Defined in: src/threads/ThreadWorker.ts:21
|
|
29
|
+
Defined in: [src/threads/ThreadWorker.ts:21](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L21)
|
|
30
30
|
|
|
31
31
|
The type of message sent.
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / WorkerOptions
|
|
6
6
|
|
|
7
7
|
# Interface: WorkerOptions
|
|
8
8
|
|
|
9
|
-
Defined in: src/threads/ThreadPool.ts:22
|
|
9
|
+
Defined in: [src/threads/ThreadPool.ts:22](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L22)
|
|
10
10
|
|
|
11
11
|
Describes the various options that can be used when creating worker threads.
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Describes the various options that can be used when creating worker threads.
|
|
|
16
16
|
|
|
17
17
|
> `optional` **allowTs**: `boolean`
|
|
18
18
|
|
|
19
|
-
Defined in: src/threads/ThreadPool.ts:30
|
|
19
|
+
Defined in: [src/threads/ThreadPool.ts:30](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L30)
|
|
20
20
|
|
|
21
21
|
Set to `true` to enable support for importing TypeScript modules in the worker. Default is `true`.
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ Set to `true` to enable support for importing TypeScript modules in the worker.
|
|
|
26
26
|
|
|
27
27
|
> `optional` **args**: `any`
|
|
28
28
|
|
|
29
|
-
Defined in: src/threads/ThreadPool.ts:24
|
|
29
|
+
Defined in: [src/threads/ThreadPool.ts:24](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L24)
|
|
30
30
|
|
|
31
31
|
The list of initialization arguments to pass into the worker thread.
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ The list of initialization arguments to pass into the worker thread.
|
|
|
36
36
|
|
|
37
37
|
> `optional` **entry**: `string`
|
|
38
38
|
|
|
39
|
-
Defined in: src/threads/ThreadPool.ts:26
|
|
39
|
+
Defined in: [src/threads/ThreadPool.ts:26](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L26)
|
|
40
40
|
|
|
41
41
|
The path to the entry file create a worker thread from. Default is `ThreadWorkerEntry.js`.
|
|
42
42
|
|
|
@@ -46,7 +46,7 @@ The path to the entry file create a worker thread from. Default is `ThreadWorker
|
|
|
46
46
|
|
|
47
47
|
> `optional` **restartOnExit**: `boolean`
|
|
48
48
|
|
|
49
|
-
Defined in: src/threads/ThreadPool.ts:28
|
|
49
|
+
Defined in: [src/threads/ThreadPool.ts:28](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L28)
|
|
50
50
|
|
|
51
51
|
Indicates if a worker thread should automatically be restarted on exit.
|
|
52
52
|
|
|
@@ -56,6 +56,6 @@ Indicates if a worker thread should automatically be restarted on exit.
|
|
|
56
56
|
|
|
57
57
|
> `optional` **worker**: `string`
|
|
58
58
|
|
|
59
|
-
Defined in: src/threads/ThreadPool.ts:32
|
|
59
|
+
Defined in: [src/threads/ThreadPool.ts:32](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L32)
|
|
60
60
|
|
|
61
61
|
The path to the worker file. This must be set when using `ThreadWorkerEntry` as the default entry file.
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / BooleanFunc
|
|
6
6
|
|
|
7
7
|
# Type Alias: BooleanFunc()
|
|
8
8
|
|
|
9
9
|
> **BooleanFunc** = (`val`) => `boolean`
|
|
10
10
|
|
|
11
|
-
Defined in: src/ValidationUtils.ts:9
|
|
11
|
+
Defined in: [src/ValidationUtils.ts:9](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L9)
|
|
12
12
|
|
|
13
13
|
A simple validation function that returns a boolean success or fail.
|
|
14
14
|
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / TemplateMap
|
|
6
6
|
|
|
7
7
|
# Type Alias: TemplateMap
|
|
8
8
|
|
|
9
9
|
> **TemplateMap** = `Omit`\<[`TemplateMapBase`](../interfaces/TemplateMapBase.md), `"from"`\> & `object`
|
|
10
10
|
|
|
11
|
-
Defined in: src/MessagingUtils.ts:
|
|
11
|
+
Defined in: [src/MessagingUtils.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L17)
|
|
12
12
|
|
|
13
13
|
## Type Declaration
|
|
14
14
|
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / WorkerCallback
|
|
6
6
|
|
|
7
7
|
# Type Alias: WorkerCallback()
|
|
8
8
|
|
|
9
9
|
> **WorkerCallback** = (`threadId`, `msg?`) => `void`
|
|
10
10
|
|
|
11
|
-
Defined in: src/threads/ThreadPool.ts:17
|
|
11
|
+
Defined in: [src/threads/ThreadPool.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L17)
|
|
12
12
|
|
|
13
13
|
Callback function for `ThreadPool` events.
|
|
14
14
|
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@rapidrest/core](../
|
|
5
|
+
[@rapidrest/core](../globals.md) / Logger
|
|
6
6
|
|
|
7
7
|
# Variable: Logger
|
|
8
8
|
|
|
9
9
|
> `const` **Logger**: `any`
|
|
10
10
|
|
|
11
|
-
Defined in: src/Logger.ts:17
|
|
11
|
+
Defined in: [src/Logger.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/Logger.ts#L17)
|
|
12
12
|
|
|
13
13
|
Creates a new logger with the specified level and file name to output logs to.
|
|
14
14
|
|