@twin.org/core 0.0.3-next.21 → 0.0.3-next.23

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 (78) hide show
  1. package/README.md +1 -9
  2. package/dist/es/encoding/base32.js +1 -1
  3. package/dist/es/encoding/base32.js.map +1 -1
  4. package/dist/es/factories/factory.js +1 -13
  5. package/dist/es/factories/factory.js.map +1 -1
  6. package/dist/es/helpers/arrayHelper.js.map +1 -1
  7. package/dist/es/index.js +2 -1
  8. package/dist/es/index.js.map +1 -1
  9. package/dist/es/types/objectOrArray.js.map +1 -0
  10. package/dist/es/types/singleOccurrenceArray.js +2 -0
  11. package/dist/es/types/singleOccurrenceArray.js.map +1 -0
  12. package/dist/es/utils/guards.js.map +1 -1
  13. package/dist/types/encoding/base32.d.ts +1 -1
  14. package/dist/types/factories/factory.d.ts +1 -5
  15. package/dist/types/helpers/arrayHelper.d.ts +1 -1
  16. package/dist/types/index.d.ts +2 -1
  17. package/dist/types/types/singleOccurrenceArray.d.ts +9 -0
  18. package/dist/types/utils/guards.d.ts +1 -1
  19. package/docs/changelog.md +36 -1
  20. package/docs/examples.md +308 -1
  21. package/docs/reference/classes/AlreadyExistsError.md +18 -18
  22. package/docs/reference/classes/ArrayHelper.md +2 -2
  23. package/docs/reference/classes/AsyncCache.md +6 -6
  24. package/docs/reference/classes/Base32.md +4 -4
  25. package/docs/reference/classes/Base58.md +3 -3
  26. package/docs/reference/classes/Base64.md +4 -4
  27. package/docs/reference/classes/Base64Url.md +3 -3
  28. package/docs/reference/classes/BaseError.md +17 -17
  29. package/docs/reference/classes/BitString.md +6 -6
  30. package/docs/reference/classes/Coerce.md +11 -11
  31. package/docs/reference/classes/Compression.md +3 -3
  32. package/docs/reference/classes/ConflictError.md +18 -18
  33. package/docs/reference/classes/Converter.md +18 -18
  34. package/docs/reference/classes/EnvHelper.md +1 -1
  35. package/docs/reference/classes/ErrorHelper.md +3 -3
  36. package/docs/reference/classes/Factory.md +21 -31
  37. package/docs/reference/classes/FilenameHelper.md +1 -1
  38. package/docs/reference/classes/GeneralError.md +18 -18
  39. package/docs/reference/classes/GuardError.md +18 -18
  40. package/docs/reference/classes/Guards.md +31 -31
  41. package/docs/reference/classes/HexHelper.md +6 -6
  42. package/docs/reference/classes/I18n.md +14 -14
  43. package/docs/reference/classes/Is.md +40 -40
  44. package/docs/reference/classes/JsonHelper.md +8 -8
  45. package/docs/reference/classes/NotFoundError.md +18 -18
  46. package/docs/reference/classes/NotImplementedError.md +18 -18
  47. package/docs/reference/classes/NotSupportedError.md +18 -18
  48. package/docs/reference/classes/NumberHelper.md +2 -2
  49. package/docs/reference/classes/ObjectHelper.md +20 -20
  50. package/docs/reference/classes/RandomHelper.md +6 -6
  51. package/docs/reference/classes/SharedStore.md +3 -3
  52. package/docs/reference/classes/StringHelper.md +23 -23
  53. package/docs/reference/classes/Uint8ArrayHelper.md +1 -1
  54. package/docs/reference/classes/UnauthorizedError.md +18 -18
  55. package/docs/reference/classes/UnprocessableError.md +18 -18
  56. package/docs/reference/classes/Url.md +8 -8
  57. package/docs/reference/classes/Urn.md +22 -22
  58. package/docs/reference/classes/Validation.md +25 -25
  59. package/docs/reference/classes/ValidationError.md +18 -18
  60. package/docs/reference/index.md +2 -0
  61. package/docs/reference/interfaces/IComponent.md +4 -4
  62. package/docs/reference/interfaces/IError.md +6 -6
  63. package/docs/reference/interfaces/II18nShared.md +4 -4
  64. package/docs/reference/interfaces/IKeyValue.md +2 -2
  65. package/docs/reference/interfaces/ILabelledValue.md +2 -2
  66. package/docs/reference/interfaces/ILocale.md +2 -2
  67. package/docs/reference/interfaces/ILocalesIndex.md +1 -1
  68. package/docs/reference/interfaces/IPatchOperation.md +4 -4
  69. package/docs/reference/interfaces/IUrlParts.md +6 -6
  70. package/docs/reference/interfaces/IValidationFailure.md +3 -3
  71. package/docs/reference/type-aliases/SingleOccurrenceArray.md +15 -0
  72. package/docs/reference/type-aliases/SingleOccurrenceArrayDepthHelper.md +19 -0
  73. package/docs/reference/variables/CoerceType.md +10 -10
  74. package/docs/reference/variables/CompressionType.md +2 -2
  75. package/package.json +4 -4
  76. package/dist/es/models/objectOrArray.js.map +0 -1
  77. /package/dist/es/{models → types}/objectOrArray.js +0 -0
  78. /package/dist/types/{models → types}/objectOrArray.d.ts +0 -0
@@ -14,7 +14,7 @@ Class to check types of objects.
14
14
 
15
15
  ## Methods
16
16
 
17
- ### undefined()
17
+ ### undefined() {#undefined}
18
18
 
19
19
  > `static` **undefined**(`value`): `value is undefined`
20
20
 
@@ -36,7 +36,7 @@ True if the value is a empty.
36
36
 
37
37
  ***
38
38
 
39
- ### null()
39
+ ### null() {#null}
40
40
 
41
41
  > `static` **null**(`value`): `value is null`
42
42
 
@@ -58,7 +58,7 @@ True if the value is a empty.
58
58
 
59
59
  ***
60
60
 
61
- ### empty()
61
+ ### empty() {#empty}
62
62
 
63
63
  > `static` **empty**(`value`): value is null \| undefined
64
64
 
@@ -80,7 +80,7 @@ True if the value is a empty.
80
80
 
81
81
  ***
82
82
 
83
- ### notEmpty()
83
+ ### notEmpty() {#notempty}
84
84
 
85
85
  > `static` **notEmpty**(`value`): `boolean`
86
86
 
@@ -102,7 +102,7 @@ True if the value is a not empty.
102
102
 
103
103
  ***
104
104
 
105
- ### string()
105
+ ### string() {#string}
106
106
 
107
107
  > `static` **string**(`value`): `value is string`
108
108
 
@@ -124,7 +124,7 @@ True if the value is a string.
124
124
 
125
125
  ***
126
126
 
127
- ### stringValue()
127
+ ### stringValue() {#stringvalue}
128
128
 
129
129
  > `static` **stringValue**(`value`): `value is string`
130
130
 
@@ -146,7 +146,7 @@ True if the value is a string.
146
146
 
147
147
  ***
148
148
 
149
- ### json()
149
+ ### json() {#json}
150
150
 
151
151
  > `static` **json**(`value`): `value is string`
152
152
 
@@ -168,7 +168,7 @@ True if the value is a JSON string.
168
168
 
169
169
  ***
170
170
 
171
- ### stringBase64()
171
+ ### stringBase64() {#stringbase64}
172
172
 
173
173
  > `static` **stringBase64**(`value`): `value is string`
174
174
 
@@ -190,7 +190,7 @@ True if the value is a base64 string.
190
190
 
191
191
  ***
192
192
 
193
- ### stringBase64Url()
193
+ ### stringBase64Url() {#stringbase64url}
194
194
 
195
195
  > `static` **stringBase64Url**(`value`): `value is string`
196
196
 
@@ -212,7 +212,7 @@ True if the value is a base64 string.
212
212
 
213
213
  ***
214
214
 
215
- ### stringBase58()
215
+ ### stringBase58() {#stringbase58}
216
216
 
217
217
  > `static` **stringBase58**(`value`): `value is string`
218
218
 
@@ -234,9 +234,9 @@ True if the value is a base58 string.
234
234
 
235
235
  ***
236
236
 
237
- ### stringHex()
237
+ ### stringHex() {#stringhex}
238
238
 
239
- > `static` **stringHex**(`value`, `allowPrefix`): `value is string`
239
+ > `static` **stringHex**(`value`, `allowPrefix?`): `value is string`
240
240
 
241
241
  Is the value a hex string.
242
242
 
@@ -248,7 +248,7 @@ Is the value a hex string.
248
248
 
249
249
  The value to test.
250
250
 
251
- ##### allowPrefix
251
+ ##### allowPrefix?
252
252
 
253
253
  `boolean` = `false`
254
254
 
@@ -262,9 +262,9 @@ True if the value is a hex string.
262
262
 
263
263
  ***
264
264
 
265
- ### stringHexLength()
265
+ ### stringHexLength() {#stringhexlength}
266
266
 
267
- > `static` **stringHexLength**(`value`, `length`, `allowPrefix`): `value is string`
267
+ > `static` **stringHexLength**(`value`, `length`, `allowPrefix?`): `value is string`
268
268
 
269
269
  Is the value a hex string of fixed length.
270
270
 
@@ -282,7 +282,7 @@ The value to test.
282
282
 
283
283
  The length to test.
284
284
 
285
- ##### allowPrefix
285
+ ##### allowPrefix?
286
286
 
287
287
  `boolean` = `false`
288
288
 
@@ -296,7 +296,7 @@ True if the value is a hex string of required length.
296
296
 
297
297
  ***
298
298
 
299
- ### number()
299
+ ### number() {#number}
300
300
 
301
301
  > `static` **number**(`value`): `value is number`
302
302
 
@@ -318,7 +318,7 @@ True if the value is a number.
318
318
 
319
319
  ***
320
320
 
321
- ### integer()
321
+ ### integer() {#integer}
322
322
 
323
323
  > `static` **integer**(`value`): `value is number`
324
324
 
@@ -340,7 +340,7 @@ True if the value is an integer.
340
340
 
341
341
  ***
342
342
 
343
- ### bigint()
343
+ ### bigint() {#bigint}
344
344
 
345
345
  > `static` **bigint**(`value`): `value is bigint`
346
346
 
@@ -362,7 +362,7 @@ True if the value is a big integer.
362
362
 
363
363
  ***
364
364
 
365
- ### boolean()
365
+ ### boolean() {#boolean}
366
366
 
367
367
  > `static` **boolean**(`value`): `value is boolean`
368
368
 
@@ -384,7 +384,7 @@ True if the value is a boolean.
384
384
 
385
385
  ***
386
386
 
387
- ### date()
387
+ ### date() {#date}
388
388
 
389
389
  > `static` **date**(`value`): `value is Date`
390
390
 
@@ -406,7 +406,7 @@ True if the value is a date.
406
406
 
407
407
  ***
408
408
 
409
- ### dateEmpty()
409
+ ### dateEmpty() {#dateempty}
410
410
 
411
411
  > `static` **dateEmpty**(`value`): `boolean`
412
412
 
@@ -428,7 +428,7 @@ True if the value is an empty date.
428
428
 
429
429
  ***
430
430
 
431
- ### dateString()
431
+ ### dateString() {#datestring}
432
432
 
433
433
  > `static` **dateString**(`value`): `boolean`
434
434
 
@@ -450,7 +450,7 @@ True if the value is a string in ISO 8601 date format.
450
450
 
451
451
  ***
452
452
 
453
- ### dateTimeString()
453
+ ### dateTimeString() {#datetimestring}
454
454
 
455
455
  > `static` **dateTimeString**(`value`): `boolean`
456
456
 
@@ -472,7 +472,7 @@ True if the value is a string in ISO 8601 date/time format.
472
472
 
473
473
  ***
474
474
 
475
- ### timeString()
475
+ ### timeString() {#timestring}
476
476
 
477
477
  > `static` **timeString**(`value`): `boolean`
478
478
 
@@ -494,7 +494,7 @@ True if the value is a string in ISO 8601 time format.
494
494
 
495
495
  ***
496
496
 
497
- ### timestampSeconds()
497
+ ### timestampSeconds() {#timestampseconds}
498
498
 
499
499
  > `static` **timestampSeconds**(`value`): `value is number`
500
500
 
@@ -516,7 +516,7 @@ True if the value is a date.
516
516
 
517
517
  ***
518
518
 
519
- ### timestampMilliseconds()
519
+ ### timestampMilliseconds() {#timestampmilliseconds}
520
520
 
521
521
  > `static` **timestampMilliseconds**(`value`): `value is number`
522
522
 
@@ -538,7 +538,7 @@ True if the value is a date.
538
538
 
539
539
  ***
540
540
 
541
- ### object()
541
+ ### object() {#object}
542
542
 
543
543
  > `static` **object**\<`T`\>(`value`): `value is T`
544
544
 
@@ -566,7 +566,7 @@ True if the value is a object.
566
566
 
567
567
  ***
568
568
 
569
- ### objectValue()
569
+ ### objectValue() {#objectvalue}
570
570
 
571
571
  > `static` **objectValue**\<`T`\>(`value`): `value is T`
572
572
 
@@ -594,7 +594,7 @@ True if the value is a object.
594
594
 
595
595
  ***
596
596
 
597
- ### array()
597
+ ### array() {#array}
598
598
 
599
599
  > `static` **array**\<`T`\>(`value`): `value is T[]`
600
600
 
@@ -622,7 +622,7 @@ True if the value is an array.
622
622
 
623
623
  ***
624
624
 
625
- ### arrayValue()
625
+ ### arrayValue() {#arrayvalue}
626
626
 
627
627
  > `static` **arrayValue**\<`T`\>(`value`): `value is T[]`
628
628
 
@@ -650,7 +650,7 @@ True if the value is an array with at least one element.
650
650
 
651
651
  ***
652
652
 
653
- ### arrayOneOf()
653
+ ### arrayOneOf() {#arrayoneof}
654
654
 
655
655
  > `static` **arrayOneOf**\<`T`\>(`value`, `options`): `value is T`
656
656
 
@@ -684,7 +684,7 @@ True if the value is an element from the options array.
684
684
 
685
685
  ***
686
686
 
687
- ### uint8Array()
687
+ ### uint8Array() {#uint8array}
688
688
 
689
689
  > `static` **uint8Array**(`value`): `value is Uint8Array<ArrayBufferLike>`
690
690
 
@@ -706,7 +706,7 @@ True if the value is a Uint8Array.
706
706
 
707
707
  ***
708
708
 
709
- ### typedArray()
709
+ ### typedArray() {#typedarray}
710
710
 
711
711
  > `static` **typedArray**(`value`): value is Uint8Array\<ArrayBufferLike\> \| Int8Array\<ArrayBufferLike\> \| Uint16Array\<ArrayBufferLike\> \| Int16Array\<ArrayBufferLike\> \| Uint32Array\<ArrayBufferLike\> \| Int32Array\<ArrayBufferLike\> \| Float32Array\<ArrayBufferLike\> \| Float64Array\<ArrayBufferLike\>
712
712
 
@@ -728,7 +728,7 @@ True if the value is a TypedArray.
728
728
 
729
729
  ***
730
730
 
731
- ### function()
731
+ ### function() {#function}
732
732
 
733
733
  > `static` **function**\<`T`\>(`value`): `value is T`
734
734
 
@@ -756,7 +756,7 @@ True if the value is a function.
756
756
 
757
757
  ***
758
758
 
759
- ### email()
759
+ ### email() {#email}
760
760
 
761
761
  > `static` **email**(`value`): `value is string`
762
762
 
@@ -778,7 +778,7 @@ True if the value is a string.
778
778
 
779
779
  ***
780
780
 
781
- ### promise()
781
+ ### promise() {#promise}
782
782
 
783
783
  > `static` **promise**\<`T`\>(`value`): `value is Promise<T>`
784
784
 
@@ -806,7 +806,7 @@ True if the value is a promise.
806
806
 
807
807
  ***
808
808
 
809
- ### regexp()
809
+ ### regexp() {#regexp}
810
810
 
811
811
  > `static` **regexp**(`value`): `value is RegExp`
812
812
 
@@ -828,7 +828,7 @@ True if the value is a regexp.
828
828
 
829
829
  ***
830
830
 
831
- ### class()
831
+ ### class() {#class}
832
832
 
833
833
  > `static` **class**\<`T`\>(`obj`): `obj is (args: any[]) => T`
834
834
 
@@ -856,7 +856,7 @@ True if the object is a class, false otherwise.
856
856
 
857
857
  ***
858
858
 
859
- ### uuidV7()
859
+ ### uuidV7() {#uuidv7}
860
860
 
861
861
  > `static` **uuidV7**(`value`, `format?`): `value is string`
862
862
 
@@ -14,7 +14,7 @@ Helpers methods for JSON objects.
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
- ### canonicalize()
25
+ ### canonicalize() {#canonicalize}
26
26
 
27
27
  > `static` **canonicalize**(`object`): `string`
28
28
 
@@ -45,7 +45,7 @@ The serialized object.
45
45
 
46
46
  ***
47
47
 
48
- ### diff()
48
+ ### diff() {#diff}
49
49
 
50
50
  > `static` **diff**\<`T`\>(`object1`, `object2`): [`IPatchOperation`](../interfaces/IPatchOperation.md)[]
51
51
 
@@ -80,7 +80,7 @@ The list of patches.
80
80
 
81
81
  ***
82
82
 
83
- ### patch()
83
+ ### patch() {#patch}
84
84
 
85
85
  > `static` **patch**\<`T`\>(`object`, `patches`): `T`
86
86
 
@@ -119,7 +119,7 @@ GeneralError if the patch fails.
119
119
 
120
120
  ***
121
121
 
122
- ### stringifyEx()
122
+ ### stringifyEx() {#stringifyex}
123
123
 
124
124
  > `static` **stringifyEx**(`object`, `space?`): `string`
125
125
 
@@ -147,7 +147,7 @@ The stringified object.
147
147
 
148
148
  ***
149
149
 
150
- ### parseEx()
150
+ ### parseEx() {#parseex}
151
151
 
152
152
  > `static` **parseEx**(`json`): `any`
153
153
 
@@ -169,7 +169,7 @@ The object.
169
169
 
170
170
  ***
171
171
 
172
- ### stringifyExReplacer()
172
+ ### stringifyExReplacer() {#stringifyexreplacer}
173
173
 
174
174
  > `static` **stringifyExReplacer**(`this`, `key`, `value`): `unknown`
175
175
 
@@ -203,7 +203,7 @@ The value.
203
203
 
204
204
  ***
205
205
 
206
- ### parseExReviver()
206
+ ### parseExReviver() {#parseexreviver}
207
207
 
208
208
  > `static` **parseExReviver**(`this`, `key`, `value`): `unknown`
209
209
 
@@ -54,7 +54,7 @@ The cause of the error if we have wrapped another error.
54
54
 
55
55
  ## Properties
56
56
 
57
- ### source?
57
+ ### source? {#source}
58
58
 
59
59
  > `optional` **source**: `string`
60
60
 
@@ -66,7 +66,7 @@ The source of the error.
66
66
 
67
67
  ***
68
68
 
69
- ### properties?
69
+ ### properties? {#properties}
70
70
 
71
71
  > `optional` **properties**: `object`
72
72
 
@@ -82,7 +82,7 @@ Any additional information for the error.
82
82
 
83
83
  ***
84
84
 
85
- ### cause?
85
+ ### cause? {#cause}
86
86
 
87
87
  > `optional` **cause**: [`IError`](../interfaces/IError.md)
88
88
 
@@ -94,7 +94,7 @@ The cause of the error.
94
94
 
95
95
  ***
96
96
 
97
- ### CLASS\_NAME
97
+ ### CLASS\_NAME {#class_name}
98
98
 
99
99
  > `readonly` `static` **CLASS\_NAME**: `string`
100
100
 
@@ -102,7 +102,7 @@ Runtime name for the class.
102
102
 
103
103
  ## Methods
104
104
 
105
- ### fromError()
105
+ ### fromError() {#fromerror}
106
106
 
107
107
  > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
108
108
 
@@ -128,7 +128,7 @@ The new instance.
128
128
 
129
129
  ***
130
130
 
131
- ### flatten()
131
+ ### flatten() {#flatten}
132
132
 
133
133
  > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
134
134
 
@@ -154,7 +154,7 @@ The list of all internal errors.
154
154
 
155
155
  ***
156
156
 
157
- ### expand()
157
+ ### expand() {#expand}
158
158
 
159
159
  > `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
160
160
 
@@ -180,7 +180,7 @@ The first level error.
180
180
 
181
181
  ***
182
182
 
183
- ### isErrorName()
183
+ ### isErrorName() {#iserrorname}
184
184
 
185
185
  > `static` **isErrorName**(`error`, `name`): `error is BaseError`
186
186
 
@@ -212,7 +212,7 @@ True if the error has the name.
212
212
 
213
213
  ***
214
214
 
215
- ### isErrorMessage()
215
+ ### isErrorMessage() {#iserrormessage}
216
216
 
217
217
  > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
218
218
 
@@ -244,7 +244,7 @@ True if the error has the name.
244
244
 
245
245
  ***
246
246
 
247
- ### isErrorCode()
247
+ ### isErrorCode() {#iserrorcode}
248
248
 
249
249
  > `static` **isErrorCode**(`error`, `code`): `boolean`
250
250
 
@@ -276,7 +276,7 @@ True if the error has the code.
276
276
 
277
277
  ***
278
278
 
279
- ### someErrorName()
279
+ ### someErrorName() {#someerrorname}
280
280
 
281
281
  > `static` **someErrorName**(`error`, `name`): `error is BaseError`
282
282
 
@@ -308,7 +308,7 @@ True if the error has the name.
308
308
 
309
309
  ***
310
310
 
311
- ### someErrorMessage()
311
+ ### someErrorMessage() {#someerrormessage}
312
312
 
313
313
  > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
314
314
 
@@ -340,7 +340,7 @@ True if the error has the name.
340
340
 
341
341
  ***
342
342
 
343
- ### someErrorClass()
343
+ ### someErrorClass() {#someerrorclass}
344
344
 
345
345
  > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
346
346
 
@@ -372,7 +372,7 @@ True if the error has the specific class.
372
372
 
373
373
  ***
374
374
 
375
- ### someErrorCode()
375
+ ### someErrorCode() {#someerrorcode}
376
376
 
377
377
  > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
378
378
 
@@ -404,7 +404,7 @@ True if the error has the name.
404
404
 
405
405
  ***
406
406
 
407
- ### isEmpty()
407
+ ### isEmpty() {#isempty}
408
408
 
409
409
  > `static` **isEmpty**(`err`): `boolean`
410
410
 
@@ -430,7 +430,7 @@ True if the error is empty.
430
430
 
431
431
  ***
432
432
 
433
- ### isAggregateError()
433
+ ### isAggregateError() {#isaggregateerror}
434
434
 
435
435
  > `static` **isAggregateError**(`err`): `err is AggregateError`
436
436
 
@@ -456,7 +456,7 @@ True if the error is an aggregate error.
456
456
 
457
457
  ***
458
458
 
459
- ### fromAggregate()
459
+ ### fromAggregate() {#fromaggregate}
460
460
 
461
461
  > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
462
462
 
@@ -488,7 +488,7 @@ The array of errors.
488
488
 
489
489
  ***
490
490
 
491
- ### toJsonObject()
491
+ ### toJsonObject() {#tojsonobject}
492
492
 
493
493
  > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
494
494
 
@@ -48,7 +48,7 @@ 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
53
  > `optional` **source**: `string`
54
54
 
@@ -60,7 +60,7 @@ The source of the error.
60
60
 
61
61
  ***
62
62
 
63
- ### properties?
63
+ ### properties? {#properties}
64
64
 
65
65
  > `optional` **properties**: `object`
66
66
 
@@ -76,7 +76,7 @@ Any additional information for the error.
76
76
 
77
77
  ***
78
78
 
79
- ### cause?
79
+ ### cause? {#cause}
80
80
 
81
81
  > `optional` **cause**: [`IError`](../interfaces/IError.md)
82
82
 
@@ -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
 
@@ -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
 
@@ -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
 
@@ -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
 
@@ -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
 
@@ -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
 
@@ -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
 
@@ -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