@rapidrest/core 1.1.0 → 1.2.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.
Files changed (83) hide show
  1. package/dist/lib/AlertUtils.js +0 -6
  2. package/dist/lib/AlertUtils.js.map +1 -1
  3. package/dist/lib/ApiError.js +0 -4
  4. package/dist/lib/ApiError.js.map +1 -1
  5. package/dist/lib/ClassLoader.js +9 -9
  6. package/dist/lib/ClassLoader.js.map +1 -1
  7. package/dist/lib/JWTUtils.js +11 -8
  8. package/dist/lib/JWTUtils.js.map +1 -1
  9. package/dist/lib/MessagingUtils.js +6 -7
  10. package/dist/lib/MessagingUtils.js.map +1 -1
  11. package/dist/lib/NotificationsUtils.js +0 -2
  12. package/dist/lib/NotificationsUtils.js.map +1 -1
  13. package/dist/lib/ObjectFactory.js +40 -16
  14. package/dist/lib/ObjectFactory.js.map +1 -1
  15. package/dist/lib/TelemetryUtils.js +6 -30
  16. package/dist/lib/TelemetryUtils.js.map +1 -1
  17. package/dist/lib/UserUtils.js +0 -32
  18. package/dist/lib/UserUtils.js.map +1 -1
  19. package/dist/lib/decorators/ObjectDecorators.js +1 -5
  20. package/dist/lib/decorators/ObjectDecorators.js.map +1 -1
  21. package/dist/lib/threads/ThreadPool.js +6 -14
  22. package/dist/lib/threads/ThreadPool.js.map +1 -1
  23. package/dist/lib/threads/ThreadWorker.js +0 -1
  24. package/dist/lib/threads/ThreadWorker.js.map +1 -1
  25. package/dist/types/ObjectFactory.d.ts +5 -4
  26. package/dist/types/UserUtils.d.ts +0 -12
  27. package/dist/types/decorators/ObjectDecorators.d.ts +1 -5
  28. package/dist/types/threads/ThreadPool.d.ts +0 -1
  29. package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Config.md +4 -18
  30. package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Destroy.md +1 -1
  31. package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Init.md +3 -3
  32. package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Inject.md +6 -18
  33. package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Logger.md +2 -2
  34. package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Nullable.md +2 -2
  35. package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Validator.md +2 -16
  36. package/docs/reference/@rapidrest/namespaces/ObjectDecorators/type-aliases/ValidatorFunction.md +2 -2
  37. package/docs/reference/classes/AlertUtils.md +10 -10
  38. package/docs/reference/classes/ApiError.md +10 -22
  39. package/docs/reference/classes/ClassLoader.md +17 -17
  40. package/docs/reference/classes/Event.md +8 -8
  41. package/docs/reference/classes/EventUtils.md +4 -4
  42. package/docs/reference/classes/FileUtils.md +17 -17
  43. package/docs/reference/classes/JWTUtils.md +5 -5
  44. package/docs/reference/classes/MessagingUtils.md +12 -12
  45. package/docs/reference/classes/OASUtils.md +8 -8
  46. package/docs/reference/classes/ObjectFactory.md +25 -23
  47. package/docs/reference/classes/ObjectUtils.md +2 -2
  48. package/docs/reference/classes/StringUtils.md +8 -8
  49. package/docs/reference/classes/ThreadPool.md +25 -25
  50. package/docs/reference/classes/ThreadWorker.md +6 -6
  51. package/docs/reference/classes/UserUtils.md +10 -64
  52. package/docs/reference/classes/ValidationUtils.md +14 -14
  53. package/docs/reference/enumerations/AlertPriority.md +6 -6
  54. package/docs/reference/enumerations/JWTUtilsCompressionMethods.md +2 -2
  55. package/docs/reference/enumerations/WorkerMessageType.md +5 -5
  56. package/docs/reference/functions/sleep.md +3 -3
  57. package/docs/reference/interfaces/Alert.md +14 -14
  58. package/docs/reference/interfaces/AlertAttachment.md +6 -6
  59. package/docs/reference/interfaces/AlertClose.md +5 -5
  60. package/docs/reference/interfaces/AlertUtilsAttachmentOptions.md +6 -6
  61. package/docs/reference/interfaces/AlertUtilsOptions.md +5 -5
  62. package/docs/reference/interfaces/InstanceOptions.md +13 -7
  63. package/docs/reference/interfaces/JWTPayload.md +15 -15
  64. package/docs/reference/interfaces/JWTUser.md +6 -6
  65. package/docs/reference/interfaces/JWTUtilsConfig.md +6 -6
  66. package/docs/reference/interfaces/JWTUtilsPayloadKeyOptions.md +8 -8
  67. package/docs/reference/interfaces/JWTUtilsPayloadOptions.md +5 -5
  68. package/docs/reference/interfaces/JWTUtilsPayloadPasswordOptions.md +9 -9
  69. package/docs/reference/interfaces/NewEvent.md +2 -2
  70. package/docs/reference/interfaces/OriginSettings.md +3 -3
  71. package/docs/reference/interfaces/SlackConfig.md +4 -4
  72. package/docs/reference/interfaces/SmtpAuth.md +3 -3
  73. package/docs/reference/interfaces/SmtpConfig.md +6 -6
  74. package/docs/reference/interfaces/Template.md +24 -24
  75. package/docs/reference/interfaces/TemplateMapBase.md +2 -2
  76. package/docs/reference/interfaces/TwilioConfig.md +5 -5
  77. package/docs/reference/interfaces/WorkerMessage.md +4 -4
  78. package/docs/reference/interfaces/WorkerOptions.md +11 -11
  79. package/docs/reference/type-aliases/BooleanFunc.md +2 -2
  80. package/docs/reference/type-aliases/TemplateMap.md +1 -1
  81. package/docs/reference/type-aliases/WorkerCallback.md +2 -2
  82. package/docs/reference/variables/Logger.md +5 -1
  83. package/package.json +96 -96
package/docs/reference/interfaces/NewEvent.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: NewEvent
8
8
 
9
- Defined in: [src/TelemetryUtils.ts:13](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L13)
9
+ Defined in: [src/TelemetryUtils.ts:13](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/TelemetryUtils.ts#L15)
23
+ Defined in: [src/TelemetryUtils.ts:15](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/TelemetryUtils.ts#L15)
24
24
 
25
25
  The type of event begin recorded.
package/docs/reference/interfaces/OriginSettings.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: OriginSettings
8
8
 
9
- Defined in: [src/MessagingUtils.ts:8](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L8)
9
+ Defined in: [src/MessagingUtils.ts:8](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L8)
10
10
 
11
11
  ## Properties
12
12
 
@@ -14,7 +14,7 @@ Defined in: [src/MessagingUtils.ts:8](https://github.com/rapidrest/core/blob/23a
14
14
 
15
15
  > **email**: `string`
16
16
 
17
- Defined in: [src/MessagingUtils.ts:9](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L9)
17
+ Defined in: [src/MessagingUtils.ts:9](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L9)
18
18
 
19
19
  ***
20
20
 
@@ -22,4 +22,4 @@ Defined in: [src/MessagingUtils.ts:9](https://github.com/rapidrest/core/blob/23a
22
22
 
23
23
  > **sms**: `string`
24
24
 
25
- Defined in: [src/MessagingUtils.ts:10](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L10)
25
+ Defined in: [src/MessagingUtils.ts:10](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L10)
package/docs/reference/interfaces/SlackConfig.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: SlackConfig
8
8
 
9
- Defined in: [src/MessagingUtils.ts:48](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L48)
9
+ Defined in: [src/MessagingUtils.ts:48](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L48)
10
10
 
11
11
  ## Properties
12
12
 
@@ -14,7 +14,7 @@ Defined in: [src/MessagingUtils.ts:48](https://github.com/rapidrest/core/blob/23
14
14
 
15
15
  > **name**: `string`
16
16
 
17
- Defined in: [src/MessagingUtils.ts:49](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L49)
17
+ Defined in: [src/MessagingUtils.ts:49](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L49)
18
18
 
19
19
  ***
20
20
 
@@ -22,7 +22,7 @@ Defined in: [src/MessagingUtils.ts:49](https://github.com/rapidrest/core/blob/23
22
22
 
23
23
  > **signingSecret**: `string`
24
24
 
25
- Defined in: [src/MessagingUtils.ts:51](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L51)
25
+ Defined in: [src/MessagingUtils.ts:51](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L51)
26
26
 
27
27
  ***
28
28
 
@@ -30,4 +30,4 @@ Defined in: [src/MessagingUtils.ts:51](https://github.com/rapidrest/core/blob/23
30
30
 
31
31
  > **token**: `string`
32
32
 
33
- Defined in: [src/MessagingUtils.ts:50](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L50)
33
+ Defined in: [src/MessagingUtils.ts:50](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L50)
package/docs/reference/interfaces/SmtpAuth.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: SmtpAuth
8
8
 
9
- Defined in: [src/MessagingUtils.ts:54](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L54)
9
+ Defined in: [src/MessagingUtils.ts:54](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L54)
10
10
 
11
11
  ## Properties
12
12
 
@@ -14,7 +14,7 @@ Defined in: [src/MessagingUtils.ts:54](https://github.com/rapidrest/core/blob/23
14
14
 
15
15
  > **pass**: `string`
16
16
 
17
- Defined in: [src/MessagingUtils.ts:56](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L56)
17
+ Defined in: [src/MessagingUtils.ts:56](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L56)
18
18
 
19
19
  ***
20
20
 
@@ -22,4 +22,4 @@ Defined in: [src/MessagingUtils.ts:56](https://github.com/rapidrest/core/blob/23
22
22
 
23
23
  > **user**: `string`
24
24
 
25
- Defined in: [src/MessagingUtils.ts:55](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L55)
25
+ Defined in: [src/MessagingUtils.ts:55](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L55)
package/docs/reference/interfaces/SmtpConfig.md CHANGED
@@ -6,15 +6,15 @@
6
6
 
7
7
  # Interface: SmtpConfig
8
8
 
9
- Defined in: [src/MessagingUtils.ts:59](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L59)
9
+ Defined in: [src/MessagingUtils.ts:59](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L59)
10
10
 
11
11
  ## Properties
12
12
 
13
13
  ### auth?
14
14
 
15
- > `optional` **auth**: [`SmtpAuth`](SmtpAuth.md)
15
+ > `optional` **auth?**: [`SmtpAuth`](SmtpAuth.md)
16
16
 
17
- Defined in: [src/MessagingUtils.ts:63](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L63)
17
+ Defined in: [src/MessagingUtils.ts:63](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L63)
18
18
 
19
19
  ***
20
20
 
@@ -22,7 +22,7 @@ Defined in: [src/MessagingUtils.ts:63](https://github.com/rapidrest/core/blob/23
22
22
 
23
23
  > **host**: `string`
24
24
 
25
- Defined in: [src/MessagingUtils.ts:60](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L60)
25
+ Defined in: [src/MessagingUtils.ts:60](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L60)
26
26
 
27
27
  ***
28
28
 
@@ -30,7 +30,7 @@ Defined in: [src/MessagingUtils.ts:60](https://github.com/rapidrest/core/blob/23
30
30
 
31
31
  > **port**: `number`
32
32
 
33
- Defined in: [src/MessagingUtils.ts:61](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L61)
33
+ Defined in: [src/MessagingUtils.ts:61](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L61)
34
34
 
35
35
  ***
36
36
 
@@ -38,4 +38,4 @@ Defined in: [src/MessagingUtils.ts:61](https://github.com/rapidrest/core/blob/23
38
38
 
39
39
  > **secure**: `boolean`
40
40
 
41
- Defined in: [src/MessagingUtils.ts:62](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L62)
41
+ Defined in: [src/MessagingUtils.ts:62](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L62)
package/docs/reference/interfaces/Template.md CHANGED
@@ -6,15 +6,15 @@
6
6
 
7
7
  # Interface: Template
8
8
 
9
- Defined in: [src/MessagingUtils.ts:21](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L21)
9
+ Defined in: [src/MessagingUtils.ts:21](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L21)
10
10
 
11
11
  ## Properties
12
12
 
13
13
  ### email\_options?
14
14
 
15
- > `optional` **email\_options**: `any`
15
+ > `optional` **email\_options?**: `any`
16
16
 
17
- Defined in: [src/MessagingUtils.ts:27](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L27)
17
+ Defined in: [src/MessagingUtils.ts:27](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L27)
18
18
 
19
19
  ***
20
20
 
@@ -22,84 +22,84 @@ Defined in: [src/MessagingUtils.ts:27](https://github.com/rapidrest/core/blob/23
22
22
 
23
23
  > **enabled**: `boolean`
24
24
 
25
- Defined in: [src/MessagingUtils.ts:23](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L23)
25
+ Defined in: [src/MessagingUtils.ts:23](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L23)
26
26
 
27
27
  ***
28
28
 
29
29
  ### html?
30
30
 
31
- > `optional` **html**: `string`
31
+ > `optional` **html?**: `string`
32
32
 
33
- Defined in: [src/MessagingUtils.ts:31](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L31)
33
+ Defined in: [src/MessagingUtils.ts:31](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L31)
34
34
 
35
35
  ***
36
36
 
37
37
  ### htmlPath?
38
38
 
39
- > `optional` **htmlPath**: `string`
39
+ > `optional` **htmlPath?**: `string`
40
40
 
41
- Defined in: [src/MessagingUtils.ts:33](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L33)
41
+ Defined in: [src/MessagingUtils.ts:33](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L33)
42
42
 
43
43
  ***
44
44
 
45
45
  ### loaded?
46
46
 
47
- > `optional` **loaded**: `boolean`
47
+ > `optional` **loaded?**: `boolean`
48
48
 
49
- Defined in: [src/MessagingUtils.ts:25](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L25)
49
+ Defined in: [src/MessagingUtils.ts:25](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L25)
50
50
 
51
51
  ***
52
52
 
53
53
  ### slack\_channel?
54
54
 
55
- > `optional` **slack\_channel**: `string`
55
+ > `optional` **slack\_channel?**: `string`
56
56
 
57
- Defined in: [src/MessagingUtils.ts:35](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L35)
57
+ Defined in: [src/MessagingUtils.ts:35](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L35)
58
58
 
59
59
  ***
60
60
 
61
61
  ### slack\_text?
62
62
 
63
- > `optional` **slack\_text**: `string`
63
+ > `optional` **slack\_text?**: `string`
64
64
 
65
- Defined in: [src/MessagingUtils.ts:37](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L37)
65
+ Defined in: [src/MessagingUtils.ts:37](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L37)
66
66
 
67
67
  ***
68
68
 
69
69
  ### sms?
70
70
 
71
- > `optional` **sms**: `string`
71
+ > `optional` **sms?**: `string`
72
72
 
73
- Defined in: [src/MessagingUtils.ts:39](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L39)
73
+ Defined in: [src/MessagingUtils.ts:39](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L39)
74
74
 
75
75
  ***
76
76
 
77
77
  ### sms\_options?
78
78
 
79
- > `optional` **sms\_options**: `any`
79
+ > `optional` **sms\_options?**: `any`
80
80
 
81
- Defined in: [src/MessagingUtils.ts:41](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L41)
81
+ Defined in: [src/MessagingUtils.ts:41](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L41)
82
82
 
83
83
  ***
84
84
 
85
85
  ### subject?
86
86
 
87
- > `optional` **subject**: `string`
87
+ > `optional` **subject?**: `string`
88
88
 
89
- Defined in: [src/MessagingUtils.ts:29](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L29)
89
+ Defined in: [src/MessagingUtils.ts:29](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L29)
90
90
 
91
91
  ***
92
92
 
93
93
  ### text?
94
94
 
95
- > `optional` **text**: `string`
95
+ > `optional` **text?**: `string`
96
96
 
97
- Defined in: [src/MessagingUtils.ts:43](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L43)
97
+ Defined in: [src/MessagingUtils.ts:43](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L43)
98
98
 
99
99
  ***
100
100
 
101
101
  ### textPath?
102
102
 
103
- > `optional` **textPath**: `string`
103
+ > `optional` **textPath?**: `string`
104
104
 
105
- Defined in: [src/MessagingUtils.ts:45](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L45)
105
+ Defined in: [src/MessagingUtils.ts:45](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L45)
package/docs/reference/interfaces/TemplateMapBase.md CHANGED
@@ -6,8 +6,8 @@
6
6
 
7
7
  # Interface: TemplateMapBase
8
8
 
9
- Defined in: [src/MessagingUtils.ts:13](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L13)
9
+ Defined in: [src/MessagingUtils.ts:13](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L13)
10
10
 
11
11
  ## Indexable
12
12
 
13
- \[`name`: `string`\]: [`Template`](Template.md)
13
+ > \[`name`: `string`\]: [`Template`](Template.md)
package/docs/reference/interfaces/TwilioConfig.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: TwilioConfig
8
8
 
9
- Defined in: [src/MessagingUtils.ts:66](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L66)
9
+ Defined in: [src/MessagingUtils.ts:66](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L66)
10
10
 
11
11
  ## Properties
12
12
 
@@ -14,15 +14,15 @@ Defined in: [src/MessagingUtils.ts:66](https://github.com/rapidrest/core/blob/23
14
14
 
15
15
  > **accountSid**: `string`
16
16
 
17
- Defined in: [src/MessagingUtils.ts:67](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L67)
17
+ Defined in: [src/MessagingUtils.ts:67](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L67)
18
18
 
19
19
  ***
20
20
 
21
21
  ### options?
22
22
 
23
- > `optional` **options**: `any`
23
+ > `optional` **options?**: `any`
24
24
 
25
- Defined in: [src/MessagingUtils.ts:69](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L69)
25
+ Defined in: [src/MessagingUtils.ts:69](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L69)
26
26
 
27
27
  ***
28
28
 
@@ -30,4 +30,4 @@ Defined in: [src/MessagingUtils.ts:69](https://github.com/rapidrest/core/blob/23
30
30
 
31
31
  > **token**: `string`
32
32
 
33
- Defined in: [src/MessagingUtils.ts:68](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L68)
33
+ Defined in: [src/MessagingUtils.ts:68](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L68)
package/docs/reference/interfaces/WorkerMessage.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: WorkerMessage
8
8
 
9
- Defined in: [src/threads/ThreadWorker.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L17)
9
+ Defined in: [src/threads/ThreadWorker.ts:17](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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
 
@@ -14,9 +14,9 @@ Describes a single message sent from the thread pool managger to a worker thread
14
14
 
15
15
  ### data?
16
16
 
17
- > `optional` **data**: `any`
17
+ > `optional` **data?**: `any`
18
18
 
19
- Defined in: [src/threads/ThreadWorker.ts:19](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L19)
19
+ Defined in: [src/threads/ThreadWorker.ts:19](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L21)
29
+ Defined in: [src/threads/ThreadWorker.ts:21](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L21)
30
30
 
31
31
  The type of message sent.
package/docs/reference/interfaces/WorkerOptions.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: WorkerOptions
8
8
 
9
- Defined in: [src/threads/ThreadPool.ts:22](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L22)
9
+ Defined in: [src/threads/ThreadPool.ts:25](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L25)
10
10
 
11
11
  Describes the various options that can be used when creating worker threads.
12
12
 
@@ -14,9 +14,9 @@ Describes the various options that can be used when creating worker threads.
14
14
 
15
15
  ### allowTs?
16
16
 
17
- > `optional` **allowTs**: `boolean`
17
+ > `optional` **allowTs?**: `boolean`
18
18
 
19
- Defined in: [src/threads/ThreadPool.ts:30](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L30)
19
+ Defined in: [src/threads/ThreadPool.ts:33](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L33)
20
20
 
21
21
  Set to `true` to enable support for importing TypeScript modules in the worker. Default is `true`.
22
22
 
@@ -24,9 +24,9 @@ Set to `true` to enable support for importing TypeScript modules in the worker.
24
24
 
25
25
  ### args?
26
26
 
27
- > `optional` **args**: `any`
27
+ > `optional` **args?**: `any`
28
28
 
29
- Defined in: [src/threads/ThreadPool.ts:24](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L24)
29
+ Defined in: [src/threads/ThreadPool.ts:27](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L27)
30
30
 
31
31
  The list of initialization arguments to pass into the worker thread.
32
32
 
@@ -34,9 +34,9 @@ The list of initialization arguments to pass into the worker thread.
34
34
 
35
35
  ### entry?
36
36
 
37
- > `optional` **entry**: `string`
37
+ > `optional` **entry?**: `string`
38
38
 
39
- Defined in: [src/threads/ThreadPool.ts:26](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L26)
39
+ Defined in: [src/threads/ThreadPool.ts:29](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L29)
40
40
 
41
41
  The path to the entry file create a worker thread from. Default is `ThreadWorkerEntry.js`.
42
42
 
@@ -44,9 +44,9 @@ The path to the entry file create a worker thread from. Default is `ThreadWorker
44
44
 
45
45
  ### restartOnExit?
46
46
 
47
- > `optional` **restartOnExit**: `boolean`
47
+ > `optional` **restartOnExit?**: `boolean`
48
48
 
49
- Defined in: [src/threads/ThreadPool.ts:28](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L28)
49
+ Defined in: [src/threads/ThreadPool.ts:31](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L31)
50
50
 
51
51
  Indicates if a worker thread should automatically be restarted on exit.
52
52
 
@@ -54,8 +54,8 @@ Indicates if a worker thread should automatically be restarted on exit.
54
54
 
55
55
  ### worker?
56
56
 
57
- > `optional` **worker**: `string`
57
+ > `optional` **worker?**: `string`
58
58
 
59
- Defined in: [src/threads/ThreadPool.ts:32](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L32)
59
+ Defined in: [src/threads/ThreadPool.ts:35](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L35)
60
60
 
61
61
  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 CHANGED
@@ -4,11 +4,11 @@
4
4
 
5
5
  [@rapidrest/core](../globals.md) / BooleanFunc
6
6
 
7
- # Type Alias: BooleanFunc()
7
+ # Type Alias: BooleanFunc
8
8
 
9
9
  > **BooleanFunc** = (`val`) => `boolean`
10
10
 
11
- Defined in: [src/ValidationUtils.ts:9](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L9)
11
+ Defined in: [src/ValidationUtils.ts:9](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L9)
12
12
 
13
13
  A simple validation function that returns a boolean success or fail.
14
14
 
package/docs/reference/type-aliases/TemplateMap.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **TemplateMap** = `Omit`\<[`TemplateMapBase`](../interfaces/TemplateMapBase.md), `"from"`\> & `object`
10
10
 
11
- Defined in: [src/MessagingUtils.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L17)
11
+ Defined in: [src/MessagingUtils.ts:17](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L17)
12
12
 
13
13
  ## Type Declaration
14
14
 
package/docs/reference/type-aliases/WorkerCallback.md CHANGED
@@ -4,11 +4,11 @@
4
4
 
5
5
  [@rapidrest/core](../globals.md) / WorkerCallback
6
6
 
7
- # Type Alias: WorkerCallback()
7
+ # Type Alias: WorkerCallback
8
8
 
9
9
  > **WorkerCallback** = (`threadId`, `msg?`) => `void`
10
10
 
11
- Defined in: [src/threads/ThreadPool.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L17)
11
+ Defined in: [src/threads/ThreadPool.ts:20](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L20)
12
12
 
13
13
  Callback function for `ThreadPool` events.
14
14
 
package/docs/reference/variables/Logger.md CHANGED
@@ -8,14 +8,18 @@
8
8
 
9
9
  > `const` **Logger**: `any`
10
10
 
11
- Defined in: [src/Logger.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/Logger.ts#L17)
11
+ Defined in: [src/Logger.ts:17](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/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
 
15
15
  ## Param
16
16
 
17
+ **level**
18
+
17
19
  The logging level to create the logger with.
18
20
 
19
21
  ## Param
20
22
 
23
+ **file**
24
+
21
25
  The name (without an extension) of the file to output logs to.