@twin.org/core 0.0.3-next.22 → 0.0.3-next.24

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 (76) 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/helpers/arrayHelper.js.map +1 -1
  5. package/dist/es/index.js +2 -1
  6. package/dist/es/index.js.map +1 -1
  7. package/dist/es/types/objectOrArray.js.map +1 -0
  8. package/dist/es/types/singleOccurrenceArray.js +2 -0
  9. package/dist/es/types/singleOccurrenceArray.js.map +1 -0
  10. package/dist/es/utils/guards.js.map +1 -1
  11. package/dist/types/encoding/base32.d.ts +1 -1
  12. package/dist/types/helpers/arrayHelper.d.ts +1 -1
  13. package/dist/types/index.d.ts +2 -1
  14. package/dist/types/types/singleOccurrenceArray.d.ts +9 -0
  15. package/dist/types/utils/guards.d.ts +1 -1
  16. package/docs/changelog.md +36 -1
  17. package/docs/examples.md +308 -1
  18. package/docs/reference/classes/AlreadyExistsError.md +35 -35
  19. package/docs/reference/classes/ArrayHelper.md +2 -2
  20. package/docs/reference/classes/AsyncCache.md +8 -8
  21. package/docs/reference/classes/Base32.md +4 -4
  22. package/docs/reference/classes/Base58.md +3 -3
  23. package/docs/reference/classes/Base64.md +4 -4
  24. package/docs/reference/classes/Base64Url.md +3 -3
  25. package/docs/reference/classes/BaseError.md +34 -34
  26. package/docs/reference/classes/BitString.md +6 -6
  27. package/docs/reference/classes/Coerce.md +11 -11
  28. package/docs/reference/classes/Compression.md +3 -3
  29. package/docs/reference/classes/ConflictError.md +35 -35
  30. package/docs/reference/classes/Converter.md +18 -18
  31. package/docs/reference/classes/EnvHelper.md +1 -1
  32. package/docs/reference/classes/ErrorHelper.md +3 -3
  33. package/docs/reference/classes/Factory.md +20 -20
  34. package/docs/reference/classes/FilenameHelper.md +1 -1
  35. package/docs/reference/classes/GeneralError.md +35 -35
  36. package/docs/reference/classes/GuardError.md +35 -35
  37. package/docs/reference/classes/Guards.md +33 -33
  38. package/docs/reference/classes/HexHelper.md +6 -6
  39. package/docs/reference/classes/I18n.md +14 -14
  40. package/docs/reference/classes/Is.md +42 -42
  41. package/docs/reference/classes/JsonHelper.md +10 -10
  42. package/docs/reference/classes/NotFoundError.md +35 -35
  43. package/docs/reference/classes/NotImplementedError.md +35 -35
  44. package/docs/reference/classes/NotSupportedError.md +35 -35
  45. package/docs/reference/classes/NumberHelper.md +2 -2
  46. package/docs/reference/classes/ObjectHelper.md +32 -32
  47. package/docs/reference/classes/RandomHelper.md +8 -8
  48. package/docs/reference/classes/SharedStore.md +3 -3
  49. package/docs/reference/classes/StringHelper.md +23 -23
  50. package/docs/reference/classes/Uint8ArrayHelper.md +1 -1
  51. package/docs/reference/classes/UnauthorizedError.md +35 -35
  52. package/docs/reference/classes/UnprocessableError.md +35 -35
  53. package/docs/reference/classes/Url.md +8 -8
  54. package/docs/reference/classes/Urn.md +24 -24
  55. package/docs/reference/classes/Validation.md +25 -25
  56. package/docs/reference/classes/ValidationError.md +35 -35
  57. package/docs/reference/index.md +2 -0
  58. package/docs/reference/interfaces/IComponent.md +4 -4
  59. package/docs/reference/interfaces/IError.md +10 -10
  60. package/docs/reference/interfaces/II18nShared.md +4 -4
  61. package/docs/reference/interfaces/IKeyValue.md +2 -2
  62. package/docs/reference/interfaces/ILabelledValue.md +2 -2
  63. package/docs/reference/interfaces/ILocale.md +2 -2
  64. package/docs/reference/interfaces/ILocaleDictionary.md +1 -1
  65. package/docs/reference/interfaces/ILocalesIndex.md +1 -1
  66. package/docs/reference/interfaces/IPatchOperation.md +6 -6
  67. package/docs/reference/interfaces/IUrlParts.md +9 -9
  68. package/docs/reference/interfaces/IValidationFailure.md +4 -4
  69. package/docs/reference/type-aliases/SingleOccurrenceArray.md +15 -0
  70. package/docs/reference/type-aliases/SingleOccurrenceArrayDepthHelper.md +19 -0
  71. package/docs/reference/variables/CoerceType.md +10 -10
  72. package/docs/reference/variables/CompressionType.md +2 -2
  73. package/package.json +4 -4
  74. package/dist/es/models/objectOrArray.js.map +0 -1
  75. /package/dist/es/{models → types}/objectOrArray.js +0 -0
  76. /package/dist/types/{models → types}/objectOrArray.d.ts +0 -0
package/docs/reference/classes/NotImplementedError.md CHANGED
@@ -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**: `string`
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**: `object`
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**: [`IError`](../interfaces/IError.md)
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
- The list of errors to expand.
161
+ [`IError`](../interfaces/IError.md)[] \| `undefined`
162
162
 
163
- [`IError`](../interfaces/IError.md)[] | `undefined`
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
- The name to check for.
193
+ `string` \| `RegExp`
194
194
 
195
- `string` | `RegExp`
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
- The message to check for.
225
+ `string` \| `RegExp`
226
226
 
227
- `string` | `RegExp`
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
- The code to check for.
257
+ `string` \| `RegExp`
258
258
 
259
- `string` | `RegExp`
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
- The name to check for.
289
+ `string` \| `RegExp`
290
290
 
291
- `string` | `RegExp`
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
- The message to check for.
321
+ `string` \| `RegExp`
322
322
 
323
- `string` | `RegExp`
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
- The code to check for.
385
+ `string` \| `RegExp`
386
386
 
387
- `string` | `RegExp`
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
 
package/docs/reference/classes/NotSupportedError.md CHANGED
@@ -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**: `string`
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**: `object`
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**: [`IError`](../interfaces/IError.md)
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
- The list of errors to expand.
161
+ [`IError`](../interfaces/IError.md)[] \| `undefined`
162
162
 
163
- [`IError`](../interfaces/IError.md)[] | `undefined`
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
- The name to check for.
193
+ `string` \| `RegExp`
194
194
 
195
- `string` | `RegExp`
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
- The message to check for.
225
+ `string` \| `RegExp`
226
226
 
227
- `string` | `RegExp`
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
- The code to check for.
257
+ `string` \| `RegExp`
258
258
 
259
- `string` | `RegExp`
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
- The name to check for.
289
+ `string` \| `RegExp`
290
290
 
291
- `string` | `RegExp`
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
- The message to check for.
321
+ `string` \| `RegExp`
322
322
 
323
- `string` | `RegExp`
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
- The code to check for.
385
+ `string` \| `RegExp`
386
386
 
387
- `string` | `RegExp`
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
 
package/docs/reference/classes/NumberHelper.md CHANGED
@@ -14,7 +14,7 @@ Class to help with numbers.
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
- ### clamp()
25
+ ### clamp() {#clamp}
26
26
 
27
27
  > `static` **clamp**(`value`, `minValue?`, `maxValue?`): `number`
28
28