@twin.org/core 0.0.3-next.9 → 0.0.3
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.md +1 -9
- package/dist/es/encoding/base32.js +1 -1
- package/dist/es/encoding/base32.js.map +1 -1
- package/dist/es/encoding/base64.js +1 -1
- package/dist/es/encoding/base64.js.map +1 -1
- package/dist/es/errors/alreadyExistsError.js +1 -1
- package/dist/es/errors/alreadyExistsError.js.map +1 -1
- package/dist/es/errors/baseError.js +1 -1
- package/dist/es/errors/baseError.js.map +1 -1
- package/dist/es/errors/conflictError.js +1 -1
- package/dist/es/errors/conflictError.js.map +1 -1
- package/dist/es/errors/generalError.js +1 -1
- package/dist/es/errors/generalError.js.map +1 -1
- package/dist/es/errors/guardError.js +1 -1
- package/dist/es/errors/guardError.js.map +1 -1
- package/dist/es/errors/notFoundError.js +1 -1
- package/dist/es/errors/notFoundError.js.map +1 -1
- package/dist/es/errors/notSupportedError.js +1 -1
- package/dist/es/errors/notSupportedError.js.map +1 -1
- package/dist/es/errors/unauthorizedError.js +2 -2
- package/dist/es/errors/unauthorizedError.js.map +1 -1
- package/dist/es/errors/unprocessableError.js +1 -1
- package/dist/es/errors/unprocessableError.js.map +1 -1
- package/dist/es/factories/factory.js +41 -0
- package/dist/es/factories/factory.js.map +1 -1
- package/dist/es/helpers/arrayHelper.js +2 -0
- package/dist/es/helpers/arrayHelper.js.map +1 -1
- package/dist/es/helpers/errorHelper.js +18 -14
- package/dist/es/helpers/errorHelper.js.map +1 -1
- package/dist/es/helpers/jsonHelper.js.map +1 -1
- package/dist/es/helpers/objectHelper.js +12 -36
- package/dist/es/helpers/objectHelper.js.map +1 -1
- package/dist/es/helpers/stringHelper.js +11 -0
- package/dist/es/helpers/stringHelper.js.map +1 -1
- package/dist/es/index.js +8 -1
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IComponent.js +0 -2
- package/dist/es/models/IComponent.js.map +1 -1
- package/dist/es/models/IError.js.map +1 -1
- package/dist/es/models/IHealth.js +2 -0
- package/dist/es/models/IHealth.js.map +1 -0
- package/dist/es/models/IMutexWorkerMessage.js +2 -0
- package/dist/es/models/IMutexWorkerMessage.js.map +1 -0
- package/dist/es/models/healthStatus.js +21 -0
- package/dist/es/models/healthStatus.js.map +1 -0
- package/dist/es/models/mutexMessageTypes.js +13 -0
- package/dist/es/models/mutexMessageTypes.js.map +1 -0
- package/dist/es/types/objectOrArray.js.map +1 -0
- package/dist/es/types/singleOccurrenceArray.js +2 -0
- package/dist/es/types/singleOccurrenceArray.js.map +1 -0
- package/dist/es/types/singleOccurrenceArrayDepthHelper.js +2 -0
- package/dist/es/types/singleOccurrenceArrayDepthHelper.js.map +1 -0
- package/dist/es/types/urn.js +1 -2
- package/dist/es/types/urn.js.map +1 -1
- package/dist/es/utils/asyncCache.js +236 -88
- package/dist/es/utils/asyncCache.js.map +1 -1
- package/dist/es/utils/guards.js.map +1 -1
- package/dist/es/utils/i18n.js.map +1 -1
- package/dist/es/utils/mutex.js +185 -0
- package/dist/es/utils/mutex.js.map +1 -0
- package/dist/types/encoding/base32.d.ts +1 -1
- package/dist/types/errors/alreadyExistsError.d.ts +1 -1
- package/dist/types/errors/baseError.d.ts +1 -1
- package/dist/types/errors/conflictError.d.ts +1 -1
- package/dist/types/errors/generalError.d.ts +1 -1
- package/dist/types/errors/guardError.d.ts +1 -1
- package/dist/types/errors/notFoundError.d.ts +1 -1
- package/dist/types/errors/notSupportedError.d.ts +1 -1
- package/dist/types/errors/unauthorizedError.d.ts +2 -2
- package/dist/types/errors/unprocessableError.d.ts +1 -1
- package/dist/types/factories/factory.d.ts +23 -1
- package/dist/types/helpers/arrayHelper.d.ts +1 -8
- package/dist/types/helpers/errorHelper.d.ts +11 -4
- package/dist/types/helpers/objectHelper.d.ts +18 -14
- package/dist/types/helpers/stringHelper.d.ts +6 -0
- package/dist/types/index.d.ts +8 -1
- package/dist/types/models/IComponent.d.ts +12 -0
- package/dist/types/models/IError.d.ts +1 -1
- package/dist/types/models/IHealth.d.ts +32 -0
- package/dist/types/models/IMutexWorkerMessage.d.ts +23 -0
- package/dist/types/models/healthStatus.d.ts +21 -0
- package/dist/types/models/mutexMessageTypes.d.ts +13 -0
- package/dist/types/types/singleOccurrenceArray.d.ts +6 -0
- package/dist/types/types/singleOccurrenceArrayDepthHelper.d.ts +4 -0
- package/dist/types/utils/asyncCache.d.ts +11 -3
- package/dist/types/utils/guards.d.ts +1 -1
- package/dist/types/utils/mutex.d.ts +53 -0
- package/docs/changelog.md +930 -218
- package/docs/examples.md +308 -1
- package/docs/reference/classes/AlreadyExistsError.md +36 -36
- package/docs/reference/classes/ArrayHelper.md +10 -44
- package/docs/reference/classes/AsyncCache.md +13 -12
- package/docs/reference/classes/Base32.md +4 -4
- package/docs/reference/classes/Base58.md +3 -3
- package/docs/reference/classes/Base64.md +4 -4
- package/docs/reference/classes/Base64Url.md +3 -3
- package/docs/reference/classes/BaseError.md +35 -35
- package/docs/reference/classes/BitString.md +6 -6
- package/docs/reference/classes/Coerce.md +11 -11
- package/docs/reference/classes/Compression.md +3 -3
- package/docs/reference/classes/ConflictError.md +36 -36
- package/docs/reference/classes/Converter.md +18 -18
- package/docs/reference/classes/EnvHelper.md +1 -1
- package/docs/reference/classes/ErrorHelper.md +20 -10
- package/docs/reference/classes/Factory.md +112 -18
- package/docs/reference/classes/FilenameHelper.md +1 -1
- package/docs/reference/classes/GeneralError.md +36 -36
- package/docs/reference/classes/GuardError.md +36 -36
- package/docs/reference/classes/Guards.md +33 -33
- package/docs/reference/classes/HexHelper.md +6 -6
- package/docs/reference/classes/I18n.md +14 -14
- package/docs/reference/classes/Is.md +42 -42
- package/docs/reference/classes/JsonHelper.md +10 -10
- package/docs/reference/classes/Mutex.md +128 -0
- package/docs/reference/classes/NotFoundError.md +36 -36
- package/docs/reference/classes/NotImplementedError.md +35 -35
- package/docs/reference/classes/NotSupportedError.md +36 -36
- package/docs/reference/classes/NumberHelper.md +2 -2
- package/docs/reference/classes/ObjectHelper.md +135 -73
- package/docs/reference/classes/RandomHelper.md +8 -8
- package/docs/reference/classes/SharedStore.md +3 -3
- package/docs/reference/classes/StringHelper.md +45 -23
- package/docs/reference/classes/Uint8ArrayHelper.md +1 -1
- package/docs/reference/classes/UnauthorizedError.md +37 -37
- package/docs/reference/classes/UnprocessableError.md +36 -36
- package/docs/reference/classes/Url.md +8 -8
- package/docs/reference/classes/Urn.md +24 -24
- package/docs/reference/classes/Validation.md +25 -25
- package/docs/reference/classes/ValidationError.md +35 -35
- package/docs/reference/index.md +9 -0
- package/docs/reference/interfaces/IComponent.md +40 -4
- package/docs/reference/interfaces/IError.md +11 -11
- package/docs/reference/interfaces/IHealth.md +55 -0
- package/docs/reference/interfaces/II18nShared.md +4 -4
- package/docs/reference/interfaces/IKeyValue.md +2 -2
- package/docs/reference/interfaces/ILabelledValue.md +2 -2
- package/docs/reference/interfaces/ILocale.md +2 -2
- package/docs/reference/interfaces/ILocaleDictionary.md +1 -1
- package/docs/reference/interfaces/ILocalesIndex.md +1 -1
- package/docs/reference/interfaces/IMutexWorkerMessage.md +35 -0
- package/docs/reference/interfaces/IPatchOperation.md +6 -6
- package/docs/reference/interfaces/IUrlParts.md +9 -9
- package/docs/reference/interfaces/IValidationFailure.md +4 -4
- package/docs/reference/type-aliases/HealthStatus.md +5 -0
- package/docs/reference/type-aliases/MutexMessageTypes.md +5 -0
- package/docs/reference/type-aliases/SingleOccurrenceArray.md +15 -0
- package/docs/reference/type-aliases/SingleOccurrenceArrayDepthHelper.md +19 -0
- package/docs/reference/variables/CoerceType.md +10 -10
- package/docs/reference/variables/CompressionType.md +2 -2
- package/docs/reference/variables/HealthStatus.md +25 -0
- package/docs/reference/variables/MutexMessageTypes.md +13 -0
- package/locales/en.json +8 -1
- package/package.json +6 -6
- package/dist/es/models/objectOrArray.js.map +0 -1
- /package/dist/es/{models → types}/objectOrArray.js +0 -0
- /package/dist/types/{models → types}/objectOrArray.d.ts +0 -0
|
@@ -14,7 +14,7 @@ Class to help with random generation.
|
|
|
14
14
|
|
|
15
15
|
## Properties
|
|
16
16
|
|
|
17
|
-
### CLASS\_NAME
|
|
17
|
+
### CLASS\_NAME {#class_name}
|
|
18
18
|
|
|
19
19
|
> `readonly` `static` **CLASS\_NAME**: `string`
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Runtime name for the class.
|
|
|
22
22
|
|
|
23
23
|
## Methods
|
|
24
24
|
|
|
25
|
-
### generate()
|
|
25
|
+
### generate() {#generate}
|
|
26
26
|
|
|
27
27
|
> `static` **generate**(`length`): `Uint8Array`
|
|
28
28
|
|
|
@@ -44,19 +44,19 @@ The random array.
|
|
|
44
44
|
|
|
45
45
|
***
|
|
46
46
|
|
|
47
|
-
### generateUuidV7()
|
|
47
|
+
### generateUuidV7() {#generateuuidv7}
|
|
48
48
|
|
|
49
|
-
> `static` **generateUuidV7**(`format
|
|
49
|
+
> `static` **generateUuidV7**(`format?`): `string`
|
|
50
50
|
|
|
51
51
|
Generate a new UUIDv7.
|
|
52
52
|
|
|
53
53
|
#### Parameters
|
|
54
54
|
|
|
55
|
-
##### format
|
|
55
|
+
##### format?
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
`"standard"` \| `"compact"`
|
|
58
58
|
|
|
59
|
-
|
|
59
|
+
The format of the UUIDv7 string.
|
|
60
60
|
|
|
61
61
|
#### Returns
|
|
62
62
|
|
|
@@ -66,7 +66,7 @@ The UUIDv7 string.
|
|
|
66
66
|
|
|
67
67
|
***
|
|
68
68
|
|
|
69
|
-
### uuidV7ExtractTimestamp()
|
|
69
|
+
### uuidV7ExtractTimestamp() {#uuidv7extracttimestamp}
|
|
70
70
|
|
|
71
71
|
> `static` **uuidV7ExtractTimestamp**(`uuid`): `number`
|
|
72
72
|
|
|
@@ -15,7 +15,7 @@ instance loads of a packages.
|
|
|
15
15
|
|
|
16
16
|
## Methods
|
|
17
17
|
|
|
18
|
-
### get()
|
|
18
|
+
### get() {#get}
|
|
19
19
|
|
|
20
20
|
> `static` **get**\<`T`\>(`prop`): `T` \| `undefined`
|
|
21
21
|
|
|
@@ -43,7 +43,7 @@ The property if it exists.
|
|
|
43
43
|
|
|
44
44
|
***
|
|
45
45
|
|
|
46
|
-
### set()
|
|
46
|
+
### set() {#set}
|
|
47
47
|
|
|
48
48
|
> `static` **set**\<`T`\>(`prop`, `value`): `void`
|
|
49
49
|
|
|
@@ -75,7 +75,7 @@ The value to set.
|
|
|
75
75
|
|
|
76
76
|
***
|
|
77
77
|
|
|
78
|
-
### remove()
|
|
78
|
+
### remove() {#remove}
|
|
79
79
|
|
|
80
80
|
> `static` **remove**(`prop`): `void`
|
|
81
81
|
|
|
@@ -14,7 +14,7 @@ Class to help with string.
|
|
|
14
14
|
|
|
15
15
|
## Methods
|
|
16
16
|
|
|
17
|
-
### trimTrailingSlashes()
|
|
17
|
+
### trimTrailingSlashes() {#trimtrailingslashes}
|
|
18
18
|
|
|
19
19
|
> `static` **trimTrailingSlashes**(`value`): `string`
|
|
20
20
|
|
|
@@ -36,7 +36,7 @@ The trimmed string or the original.
|
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
39
|
-
### trimLeadingSlashes()
|
|
39
|
+
### trimLeadingSlashes() {#trimleadingslashes}
|
|
40
40
|
|
|
41
41
|
> `static` **trimLeadingSlashes**(`value`): `string`
|
|
42
42
|
|
|
@@ -58,9 +58,31 @@ The trimmed string or the original.
|
|
|
58
58
|
|
|
59
59
|
***
|
|
60
60
|
|
|
61
|
-
###
|
|
61
|
+
### trimLeadingAndTrailingSlashes() {#trimleadingandtrailingslashes}
|
|
62
62
|
|
|
63
|
-
> `static` **
|
|
63
|
+
> `static` **trimLeadingAndTrailingSlashes**(`value`): `string`
|
|
64
|
+
|
|
65
|
+
Trim both leading and trailing slashes from a string.
|
|
66
|
+
|
|
67
|
+
#### Parameters
|
|
68
|
+
|
|
69
|
+
##### value
|
|
70
|
+
|
|
71
|
+
`string`
|
|
72
|
+
|
|
73
|
+
The value to trim.
|
|
74
|
+
|
|
75
|
+
#### Returns
|
|
76
|
+
|
|
77
|
+
`string`
|
|
78
|
+
|
|
79
|
+
The trimmed string or the original.
|
|
80
|
+
|
|
81
|
+
***
|
|
82
|
+
|
|
83
|
+
### kebabCase() {#kebabcase}
|
|
84
|
+
|
|
85
|
+
> `static` **kebabCase**(`input`, `stripInterfacePrefix?`): `string`
|
|
64
86
|
|
|
65
87
|
Convert the input string to kebab case.
|
|
66
88
|
|
|
@@ -72,7 +94,7 @@ Convert the input string to kebab case.
|
|
|
72
94
|
|
|
73
95
|
The input to convert.
|
|
74
96
|
|
|
75
|
-
##### stripInterfacePrefix
|
|
97
|
+
##### stripInterfacePrefix?
|
|
76
98
|
|
|
77
99
|
`boolean` = `true`
|
|
78
100
|
|
|
@@ -86,9 +108,9 @@ The kebab case version of the input.
|
|
|
86
108
|
|
|
87
109
|
***
|
|
88
110
|
|
|
89
|
-
### snakeCase()
|
|
111
|
+
### snakeCase() {#snakecase}
|
|
90
112
|
|
|
91
|
-
> `static` **snakeCase**(`input`, `stripInterfacePrefix
|
|
113
|
+
> `static` **snakeCase**(`input`, `stripInterfacePrefix?`): `string`
|
|
92
114
|
|
|
93
115
|
Convert the input string to snake case.
|
|
94
116
|
|
|
@@ -100,7 +122,7 @@ Convert the input string to snake case.
|
|
|
100
122
|
|
|
101
123
|
The input to convert.
|
|
102
124
|
|
|
103
|
-
##### stripInterfacePrefix
|
|
125
|
+
##### stripInterfacePrefix?
|
|
104
126
|
|
|
105
127
|
`boolean` = `true`
|
|
106
128
|
|
|
@@ -114,9 +136,9 @@ The snake case version of the input.
|
|
|
114
136
|
|
|
115
137
|
***
|
|
116
138
|
|
|
117
|
-
### titleCase()
|
|
139
|
+
### titleCase() {#titlecase}
|
|
118
140
|
|
|
119
|
-
> `static` **titleCase**(`input`, `stripInterfacePrefix
|
|
141
|
+
> `static` **titleCase**(`input`, `stripInterfacePrefix?`): `string`
|
|
120
142
|
|
|
121
143
|
Title case all the words.
|
|
122
144
|
|
|
@@ -128,7 +150,7 @@ Title case all the words.
|
|
|
128
150
|
|
|
129
151
|
The input to convert.
|
|
130
152
|
|
|
131
|
-
##### stripInterfacePrefix
|
|
153
|
+
##### stripInterfacePrefix?
|
|
132
154
|
|
|
133
155
|
`boolean` = `true`
|
|
134
156
|
|
|
@@ -142,9 +164,9 @@ The title case version of the input.
|
|
|
142
164
|
|
|
143
165
|
***
|
|
144
166
|
|
|
145
|
-
### pascalCase()
|
|
167
|
+
### pascalCase() {#pascalcase}
|
|
146
168
|
|
|
147
|
-
> `static` **pascalCase**(`input`, `stripInterfacePrefix
|
|
169
|
+
> `static` **pascalCase**(`input`, `stripInterfacePrefix?`): `string`
|
|
148
170
|
|
|
149
171
|
Pascal case all the words.
|
|
150
172
|
|
|
@@ -156,7 +178,7 @@ Pascal case all the words.
|
|
|
156
178
|
|
|
157
179
|
The input to convert.
|
|
158
180
|
|
|
159
|
-
##### stripInterfacePrefix
|
|
181
|
+
##### stripInterfacePrefix?
|
|
160
182
|
|
|
161
183
|
`boolean` = `true`
|
|
162
184
|
|
|
@@ -170,9 +192,9 @@ The pascal case version of the input.
|
|
|
170
192
|
|
|
171
193
|
***
|
|
172
194
|
|
|
173
|
-
### camelCase()
|
|
195
|
+
### camelCase() {#camelcase}
|
|
174
196
|
|
|
175
|
-
> `static` **camelCase**(`input`, `stripInterfacePrefix
|
|
197
|
+
> `static` **camelCase**(`input`, `stripInterfacePrefix?`): `string`
|
|
176
198
|
|
|
177
199
|
Camel case all the words.
|
|
178
200
|
|
|
@@ -184,7 +206,7 @@ Camel case all the words.
|
|
|
184
206
|
|
|
185
207
|
The input to convert.
|
|
186
208
|
|
|
187
|
-
##### stripInterfacePrefix
|
|
209
|
+
##### stripInterfacePrefix?
|
|
188
210
|
|
|
189
211
|
`boolean` = `true`
|
|
190
212
|
|
|
@@ -198,9 +220,9 @@ The camel case version of the input.
|
|
|
198
220
|
|
|
199
221
|
***
|
|
200
222
|
|
|
201
|
-
### wordPath()
|
|
223
|
+
### wordPath() {#wordpath}
|
|
202
224
|
|
|
203
|
-
> `static` **wordPath**(`input`, `stripInterfacePrefix
|
|
225
|
+
> `static` **wordPath**(`input`, `stripInterfacePrefix?`): `string`
|
|
204
226
|
|
|
205
227
|
Convert the words to a path.
|
|
206
228
|
|
|
@@ -212,7 +234,7 @@ Convert the words to a path.
|
|
|
212
234
|
|
|
213
235
|
The input to convert.
|
|
214
236
|
|
|
215
|
-
##### stripInterfacePrefix
|
|
237
|
+
##### stripInterfacePrefix?
|
|
216
238
|
|
|
217
239
|
`boolean` = `true`
|
|
218
240
|
|
|
@@ -226,7 +248,7 @@ The path version of the input.
|
|
|
226
248
|
|
|
227
249
|
***
|
|
228
250
|
|
|
229
|
-
### stripPrefix()
|
|
251
|
+
### stripPrefix() {#stripprefix}
|
|
230
252
|
|
|
231
253
|
> `static` **stripPrefix**(`input`): `string`
|
|
232
254
|
|
|
@@ -248,7 +270,7 @@ The input with any interface prefix stripped.
|
|
|
248
270
|
|
|
249
271
|
***
|
|
250
272
|
|
|
251
|
-
### words()
|
|
273
|
+
### words() {#words}
|
|
252
274
|
|
|
253
275
|
> `static` **words**(`input`): `string`[]
|
|
254
276
|
|
|
@@ -270,7 +292,7 @@ The string split into words.
|
|
|
270
292
|
|
|
271
293
|
***
|
|
272
294
|
|
|
273
|
-
### isUtf8()
|
|
295
|
+
### isUtf8() {#isutf8}
|
|
274
296
|
|
|
275
297
|
> `static` **isUtf8**(`data`): `boolean`
|
|
276
298
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Class: UnauthorizedError
|
|
2
2
|
|
|
3
|
-
Class to handle errors which are triggered by access not being
|
|
3
|
+
Class to handle errors which are triggered by access not being authorized.
|
|
4
4
|
|
|
5
5
|
## Extends
|
|
6
6
|
|
|
@@ -26,7 +26,7 @@ The source of the error.
|
|
|
26
26
|
|
|
27
27
|
`string`
|
|
28
28
|
|
|
29
|
-
The message as
|
|
29
|
+
The message as an i18n key.
|
|
30
30
|
|
|
31
31
|
##### properties?
|
|
32
32
|
|
|
@@ -48,9 +48,9 @@ The cause of the error if we have wrapped another error.
|
|
|
48
48
|
|
|
49
49
|
## Properties
|
|
50
50
|
|
|
51
|
-
### source?
|
|
51
|
+
### source? {#source}
|
|
52
52
|
|
|
53
|
-
> `optional` **source
|
|
53
|
+
> `optional` **source?**: `string`
|
|
54
54
|
|
|
55
55
|
The source of the error.
|
|
56
56
|
|
|
@@ -60,9 +60,9 @@ The source of the error.
|
|
|
60
60
|
|
|
61
61
|
***
|
|
62
62
|
|
|
63
|
-
### properties?
|
|
63
|
+
### properties? {#properties}
|
|
64
64
|
|
|
65
|
-
> `optional` **properties
|
|
65
|
+
> `optional` **properties?**: `object`
|
|
66
66
|
|
|
67
67
|
Any additional information for the error.
|
|
68
68
|
|
|
@@ -76,9 +76,9 @@ Any additional information for the error.
|
|
|
76
76
|
|
|
77
77
|
***
|
|
78
78
|
|
|
79
|
-
### cause?
|
|
79
|
+
### cause? {#cause}
|
|
80
80
|
|
|
81
|
-
> `optional` **cause
|
|
81
|
+
> `optional` **cause?**: [`IError`](../interfaces/IError.md)
|
|
82
82
|
|
|
83
83
|
The cause of the error.
|
|
84
84
|
|
|
@@ -88,7 +88,7 @@ The cause of the error.
|
|
|
88
88
|
|
|
89
89
|
***
|
|
90
90
|
|
|
91
|
-
### CLASS\_NAME
|
|
91
|
+
### CLASS\_NAME {#class_name}
|
|
92
92
|
|
|
93
93
|
> `readonly` `static` **CLASS\_NAME**: `string`
|
|
94
94
|
|
|
@@ -96,7 +96,7 @@ Runtime name for the class.
|
|
|
96
96
|
|
|
97
97
|
## Methods
|
|
98
98
|
|
|
99
|
-
### fromError()
|
|
99
|
+
### fromError() {#fromerror}
|
|
100
100
|
|
|
101
101
|
> `static` **fromError**(`err`): [`BaseError`](BaseError.md)
|
|
102
102
|
|
|
@@ -122,7 +122,7 @@ The new instance.
|
|
|
122
122
|
|
|
123
123
|
***
|
|
124
124
|
|
|
125
|
-
### flatten()
|
|
125
|
+
### flatten() {#flatten}
|
|
126
126
|
|
|
127
127
|
> `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
|
|
128
128
|
|
|
@@ -148,7 +148,7 @@ The list of all internal errors.
|
|
|
148
148
|
|
|
149
149
|
***
|
|
150
150
|
|
|
151
|
-
### expand()
|
|
151
|
+
### expand() {#expand}
|
|
152
152
|
|
|
153
153
|
> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
|
|
154
154
|
|
|
@@ -158,9 +158,9 @@ Expand an error tree.
|
|
|
158
158
|
|
|
159
159
|
##### errors
|
|
160
160
|
|
|
161
|
-
|
|
161
|
+
[`IError`](../interfaces/IError.md)[] \| `undefined`
|
|
162
162
|
|
|
163
|
-
|
|
163
|
+
The list of errors to expand.
|
|
164
164
|
|
|
165
165
|
#### Returns
|
|
166
166
|
|
|
@@ -174,7 +174,7 @@ The first level error.
|
|
|
174
174
|
|
|
175
175
|
***
|
|
176
176
|
|
|
177
|
-
### isErrorName()
|
|
177
|
+
### isErrorName() {#iserrorname}
|
|
178
178
|
|
|
179
179
|
> `static` **isErrorName**(`error`, `name`): `error is BaseError`
|
|
180
180
|
|
|
@@ -190,9 +190,9 @@ The error to test.
|
|
|
190
190
|
|
|
191
191
|
##### name
|
|
192
192
|
|
|
193
|
-
|
|
193
|
+
`string` \| `RegExp`
|
|
194
194
|
|
|
195
|
-
|
|
195
|
+
The name to check for.
|
|
196
196
|
|
|
197
197
|
#### Returns
|
|
198
198
|
|
|
@@ -206,7 +206,7 @@ True if the error has the name.
|
|
|
206
206
|
|
|
207
207
|
***
|
|
208
208
|
|
|
209
|
-
### isErrorMessage()
|
|
209
|
+
### isErrorMessage() {#iserrormessage}
|
|
210
210
|
|
|
211
211
|
> `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
|
|
212
212
|
|
|
@@ -222,9 +222,9 @@ The error to test.
|
|
|
222
222
|
|
|
223
223
|
##### message
|
|
224
224
|
|
|
225
|
-
|
|
225
|
+
`string` \| `RegExp`
|
|
226
226
|
|
|
227
|
-
|
|
227
|
+
The message to check for.
|
|
228
228
|
|
|
229
229
|
#### Returns
|
|
230
230
|
|
|
@@ -238,7 +238,7 @@ True if the error has the name.
|
|
|
238
238
|
|
|
239
239
|
***
|
|
240
240
|
|
|
241
|
-
### isErrorCode()
|
|
241
|
+
### isErrorCode() {#iserrorcode}
|
|
242
242
|
|
|
243
243
|
> `static` **isErrorCode**(`error`, `code`): `boolean`
|
|
244
244
|
|
|
@@ -254,9 +254,9 @@ The error to test.
|
|
|
254
254
|
|
|
255
255
|
##### code
|
|
256
256
|
|
|
257
|
-
|
|
257
|
+
`string` \| `RegExp`
|
|
258
258
|
|
|
259
|
-
|
|
259
|
+
The code to check for.
|
|
260
260
|
|
|
261
261
|
#### Returns
|
|
262
262
|
|
|
@@ -270,7 +270,7 @@ True if the error has the code.
|
|
|
270
270
|
|
|
271
271
|
***
|
|
272
272
|
|
|
273
|
-
### someErrorName()
|
|
273
|
+
### someErrorName() {#someerrorname}
|
|
274
274
|
|
|
275
275
|
> `static` **someErrorName**(`error`, `name`): `error is BaseError`
|
|
276
276
|
|
|
@@ -286,9 +286,9 @@ The error to test.
|
|
|
286
286
|
|
|
287
287
|
##### name
|
|
288
288
|
|
|
289
|
-
|
|
289
|
+
`string` \| `RegExp`
|
|
290
290
|
|
|
291
|
-
|
|
291
|
+
The name to check for.
|
|
292
292
|
|
|
293
293
|
#### Returns
|
|
294
294
|
|
|
@@ -302,7 +302,7 @@ True if the error has the name.
|
|
|
302
302
|
|
|
303
303
|
***
|
|
304
304
|
|
|
305
|
-
### someErrorMessage()
|
|
305
|
+
### someErrorMessage() {#someerrormessage}
|
|
306
306
|
|
|
307
307
|
> `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
|
|
308
308
|
|
|
@@ -318,9 +318,9 @@ The error to test.
|
|
|
318
318
|
|
|
319
319
|
##### message
|
|
320
320
|
|
|
321
|
-
|
|
321
|
+
`string` \| `RegExp`
|
|
322
322
|
|
|
323
|
-
|
|
323
|
+
The message to check for.
|
|
324
324
|
|
|
325
325
|
#### Returns
|
|
326
326
|
|
|
@@ -334,7 +334,7 @@ True if the error has the name.
|
|
|
334
334
|
|
|
335
335
|
***
|
|
336
336
|
|
|
337
|
-
### someErrorClass()
|
|
337
|
+
### someErrorClass() {#someerrorclass}
|
|
338
338
|
|
|
339
339
|
> `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
|
|
340
340
|
|
|
@@ -366,7 +366,7 @@ True if the error has the specific class.
|
|
|
366
366
|
|
|
367
367
|
***
|
|
368
368
|
|
|
369
|
-
### someErrorCode()
|
|
369
|
+
### someErrorCode() {#someerrorcode}
|
|
370
370
|
|
|
371
371
|
> `static` **someErrorCode**(`error`, `code`): `error is BaseError`
|
|
372
372
|
|
|
@@ -382,9 +382,9 @@ The error to test.
|
|
|
382
382
|
|
|
383
383
|
##### code
|
|
384
384
|
|
|
385
|
-
|
|
385
|
+
`string` \| `RegExp`
|
|
386
386
|
|
|
387
|
-
|
|
387
|
+
The code to check for.
|
|
388
388
|
|
|
389
389
|
#### Returns
|
|
390
390
|
|
|
@@ -398,7 +398,7 @@ True if the error has the name.
|
|
|
398
398
|
|
|
399
399
|
***
|
|
400
400
|
|
|
401
|
-
### isEmpty()
|
|
401
|
+
### isEmpty() {#isempty}
|
|
402
402
|
|
|
403
403
|
> `static` **isEmpty**(`err`): `boolean`
|
|
404
404
|
|
|
@@ -424,7 +424,7 @@ True if the error is empty.
|
|
|
424
424
|
|
|
425
425
|
***
|
|
426
426
|
|
|
427
|
-
### isAggregateError()
|
|
427
|
+
### isAggregateError() {#isaggregateerror}
|
|
428
428
|
|
|
429
429
|
> `static` **isAggregateError**(`err`): `err is AggregateError`
|
|
430
430
|
|
|
@@ -450,7 +450,7 @@ True if the error is an aggregate error.
|
|
|
450
450
|
|
|
451
451
|
***
|
|
452
452
|
|
|
453
|
-
### fromAggregate()
|
|
453
|
+
### fromAggregate() {#fromaggregate}
|
|
454
454
|
|
|
455
455
|
> `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
|
|
456
456
|
|
|
@@ -482,7 +482,7 @@ The array of errors.
|
|
|
482
482
|
|
|
483
483
|
***
|
|
484
484
|
|
|
485
|
-
### toJsonObject()
|
|
485
|
+
### toJsonObject() {#tojsonobject}
|
|
486
486
|
|
|
487
487
|
> **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
|
|
488
488
|
|