@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
@@ -10,7 +10,7 @@ Factory for creating implementation of generic types.
10
10
 
11
11
  ## Properties
12
12
 
13
- ### CLASS\_NAME
13
+ ### CLASS\_NAME {#class_name}
14
14
 
15
15
  > `readonly` `static` **CLASS\_NAME**: `string`
16
16
 
@@ -18,9 +18,9 @@ Runtime name for the class.
18
18
 
19
19
  ## Methods
20
20
 
21
- ### createFactory()
21
+ ### createFactory() {#createfactory}
22
22
 
23
- > `static` **createFactory**\<`U`\>(`typeName`, `autoInstance`, `matcher?`): `Factory`\<`U`\>
23
+ > `static` **createFactory**\<`U`\>(`typeName`, `autoInstance?`, `matcher?`): `Factory`\<`U`\>
24
24
 
25
25
  Create a new factory, which is shared throughout all library instances.
26
26
 
@@ -38,7 +38,7 @@ Create a new factory, which is shared throughout all library instances.
38
38
 
39
39
  The type name for the instances.
40
40
 
41
- ##### autoInstance
41
+ ##### autoInstance?
42
42
 
43
43
  `boolean` = `false`
44
44
 
@@ -58,7 +58,7 @@ The factory instance.
58
58
 
59
59
  ***
60
60
 
61
- ### getFactories()
61
+ ### getFactories() {#getfactories}
62
62
 
63
63
  > `static` **getFactories**(): `object`
64
64
 
@@ -72,7 +72,7 @@ All the factories.
72
72
 
73
73
  ***
74
74
 
75
- ### resetFactories()
75
+ ### resetFactories() {#resetfactories}
76
76
 
77
77
  > `static` **resetFactories**(): `void`
78
78
 
@@ -84,7 +84,7 @@ Reset all the factories, which removes any created instances, but not the regist
84
84
 
85
85
  ***
86
86
 
87
- ### clearFactories()
87
+ ### clearFactories() {#clearfactories}
88
88
 
89
89
  > `static` **clearFactories**(): `void`
90
90
 
@@ -96,7 +96,7 @@ Clear all the factories, which removes anything registered with the factories.
96
96
 
97
97
  ***
98
98
 
99
- ### typeName()
99
+ ### typeName() {#typename}
100
100
 
101
101
  > **typeName**(): `string`
102
102
 
@@ -110,9 +110,9 @@ The type name of the factory.
110
110
 
111
111
  ***
112
112
 
113
- ### register()
113
+ ### register() {#register}
114
114
 
115
- > **register**\<`U`\>(`name`, `generator`, `options?`): `void`
115
+ > **register**\<`U`\>(`name`, `generator`): `void`
116
116
 
117
117
  Register a new generator.
118
118
 
@@ -136,23 +136,13 @@ The name of the generator.
136
136
 
137
137
  The function to create an instance.
138
138
 
139
- ##### options?
140
-
141
- Options for the generator.
142
-
143
- ###### isDefault?
144
-
145
- `boolean`
146
-
147
- Whether the generator is the default one i.e. should be the first generator.
148
-
149
139
  #### Returns
150
140
 
151
141
  `void`
152
142
 
153
143
  ***
154
144
 
155
- ### unregister()
145
+ ### unregister() {#unregister}
156
146
 
157
147
  > **unregister**(`name`): `void`
158
148
 
@@ -180,7 +170,7 @@ GeneralError if no generator exists.
180
170
 
181
171
  ***
182
172
 
183
- ### get()
173
+ ### get() {#get}
184
174
 
185
175
  > **get**\<`U`\>(`name`): `U`
186
176
 
@@ -216,7 +206,7 @@ GeneralError if no item exists to get.
216
206
 
217
207
  ***
218
208
 
219
- ### getIfExists()
209
+ ### getIfExists() {#getifexists}
220
210
 
221
211
  > **getIfExists**\<`U`\>(`name?`): `U` \| `undefined`
222
212
 
@@ -244,7 +234,7 @@ An instance of the item or undefined if it does not exist.
244
234
 
245
235
  ***
246
236
 
247
- ### create()
237
+ ### create() {#create}
248
238
 
249
239
  > **create**\<`U`\>(`name`, `args?`): `U`
250
240
 
@@ -286,7 +276,7 @@ GeneralError if no item exists to create.
286
276
 
287
277
  ***
288
278
 
289
- ### createIfExists()
279
+ ### createIfExists() {#createifexists}
290
280
 
291
281
  > **createIfExists**\<`U`\>(`name`, `args?`): `U` \| `undefined`
292
282
 
@@ -324,7 +314,7 @@ GuardError if the parameters are invalid.
324
314
 
325
315
  ***
326
316
 
327
- ### reset()
317
+ ### reset() {#reset}
328
318
 
329
319
  > **reset**(): `void`
330
320
 
@@ -336,7 +326,7 @@ Remove all the instances and leave the generators intact.
336
326
 
337
327
  ***
338
328
 
339
- ### clear()
329
+ ### clear() {#clear}
340
330
 
341
331
  > **clear**(): `void`
342
332
 
@@ -348,7 +338,7 @@ Remove all the instances and the generators.
348
338
 
349
339
  ***
350
340
 
351
- ### instancesMap()
341
+ ### instancesMap() {#instancesmap}
352
342
 
353
343
  > **instancesMap**(): `object`
354
344
 
@@ -362,7 +352,7 @@ The instances as a map.
362
352
 
363
353
  ***
364
354
 
365
- ### instancesList()
355
+ ### instancesList() {#instanceslist}
366
356
 
367
357
  > **instancesList**(): `T`[]
368
358
 
@@ -376,7 +366,7 @@ The instances as a list in the order they were registered.
376
366
 
377
367
  ***
378
368
 
379
- ### names()
369
+ ### names() {#names}
380
370
 
381
371
  > **names**(): `string`[]
382
372
 
@@ -390,7 +380,7 @@ The ordered generator names.
390
380
 
391
381
  ***
392
382
 
393
- ### hasName()
383
+ ### hasName() {#hasname}
394
384
 
395
385
  > **hasName**(`name`): `boolean`
396
386
 
@@ -14,7 +14,7 @@ Class to help with filenames.
14
14
 
15
15
  ## Methods
16
16
 
17
- ### safeFilename()
17
+ ### safeFilename() {#safefilename}
18
18
 
19
19
  > `static` **safeFilename**(`filename`): `string`
20
20
 
@@ -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
 
@@ -56,7 +56,7 @@ The property options which might be allowed.
56
56
 
57
57
  ## Properties
58
58
 
59
- ### source?
59
+ ### source? {#source}
60
60
 
61
61
  > `optional` **source**: `string`
62
62
 
@@ -68,7 +68,7 @@ The source of the error.
68
68
 
69
69
  ***
70
70
 
71
- ### properties?
71
+ ### properties? {#properties}
72
72
 
73
73
  > `optional` **properties**: `object`
74
74
 
@@ -84,7 +84,7 @@ Any additional information for the error.
84
84
 
85
85
  ***
86
86
 
87
- ### cause?
87
+ ### cause? {#cause}
88
88
 
89
89
  > `optional` **cause**: [`IError`](../interfaces/IError.md)
90
90
 
@@ -96,7 +96,7 @@ The cause of the error.
96
96
 
97
97
  ***
98
98
 
99
- ### CLASS\_NAME
99
+ ### CLASS\_NAME {#class_name}
100
100
 
101
101
  > `readonly` `static` **CLASS\_NAME**: `string`
102
102
 
@@ -104,7 +104,7 @@ Runtime name for the class.
104
104
 
105
105
  ## Methods
106
106
 
107
- ### fromError()
107
+ ### fromError() {#fromerror}
108
108
 
109
109
  > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
110
110
 
@@ -130,7 +130,7 @@ The new instance.
130
130
 
131
131
  ***
132
132
 
133
- ### flatten()
133
+ ### flatten() {#flatten}
134
134
 
135
135
  > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
136
136
 
@@ -156,7 +156,7 @@ The list of all internal errors.
156
156
 
157
157
  ***
158
158
 
159
- ### expand()
159
+ ### expand() {#expand}
160
160
 
161
161
  > `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
162
162
 
@@ -182,7 +182,7 @@ The first level error.
182
182
 
183
183
  ***
184
184
 
185
- ### isErrorName()
185
+ ### isErrorName() {#iserrorname}
186
186
 
187
187
  > `static` **isErrorName**(`error`, `name`): `error is BaseError`
188
188
 
@@ -214,7 +214,7 @@ True if the error has the name.
214
214
 
215
215
  ***
216
216
 
217
- ### isErrorMessage()
217
+ ### isErrorMessage() {#iserrormessage}
218
218
 
219
219
  > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
220
220
 
@@ -246,7 +246,7 @@ True if the error has the name.
246
246
 
247
247
  ***
248
248
 
249
- ### isErrorCode()
249
+ ### isErrorCode() {#iserrorcode}
250
250
 
251
251
  > `static` **isErrorCode**(`error`, `code`): `boolean`
252
252
 
@@ -278,7 +278,7 @@ True if the error has the code.
278
278
 
279
279
  ***
280
280
 
281
- ### someErrorName()
281
+ ### someErrorName() {#someerrorname}
282
282
 
283
283
  > `static` **someErrorName**(`error`, `name`): `error is BaseError`
284
284
 
@@ -310,7 +310,7 @@ True if the error has the name.
310
310
 
311
311
  ***
312
312
 
313
- ### someErrorMessage()
313
+ ### someErrorMessage() {#someerrormessage}
314
314
 
315
315
  > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
316
316
 
@@ -342,7 +342,7 @@ True if the error has the name.
342
342
 
343
343
  ***
344
344
 
345
- ### someErrorClass()
345
+ ### someErrorClass() {#someerrorclass}
346
346
 
347
347
  > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
348
348
 
@@ -374,7 +374,7 @@ True if the error has the specific class.
374
374
 
375
375
  ***
376
376
 
377
- ### someErrorCode()
377
+ ### someErrorCode() {#someerrorcode}
378
378
 
379
379
  > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
380
380
 
@@ -406,7 +406,7 @@ True if the error has the name.
406
406
 
407
407
  ***
408
408
 
409
- ### isEmpty()
409
+ ### isEmpty() {#isempty}
410
410
 
411
411
  > `static` **isEmpty**(`err`): `boolean`
412
412
 
@@ -432,7 +432,7 @@ True if the error is empty.
432
432
 
433
433
  ***
434
434
 
435
- ### isAggregateError()
435
+ ### isAggregateError() {#isaggregateerror}
436
436
 
437
437
  > `static` **isAggregateError**(`err`): `err is AggregateError`
438
438
 
@@ -458,7 +458,7 @@ True if the error is an aggregate error.
458
458
 
459
459
  ***
460
460
 
461
- ### fromAggregate()
461
+ ### fromAggregate() {#fromaggregate}
462
462
 
463
463
  > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
464
464
 
@@ -490,7 +490,7 @@ The array of errors.
490
490
 
491
491
  ***
492
492
 
493
- ### toJsonObject()
493
+ ### toJsonObject() {#tojsonobject}
494
494
 
495
495
  > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
496
496