@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.
- 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/factories/factory.js +1 -13
- package/dist/es/factories/factory.js.map +1 -1
- package/dist/es/helpers/arrayHelper.js.map +1 -1
- package/dist/es/index.js +2 -1
- package/dist/es/index.js.map +1 -1
- 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/utils/guards.js.map +1 -1
- package/dist/types/encoding/base32.d.ts +1 -1
- package/dist/types/factories/factory.d.ts +1 -5
- package/dist/types/helpers/arrayHelper.d.ts +1 -1
- package/dist/types/index.d.ts +2 -1
- package/dist/types/types/singleOccurrenceArray.d.ts +9 -0
- package/dist/types/utils/guards.d.ts +1 -1
- package/docs/changelog.md +36 -1
- package/docs/examples.md +308 -1
- package/docs/reference/classes/AlreadyExistsError.md +18 -18
- package/docs/reference/classes/ArrayHelper.md +2 -2
- package/docs/reference/classes/AsyncCache.md +6 -6
- 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 +17 -17
- 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 +18 -18
- package/docs/reference/classes/Converter.md +18 -18
- package/docs/reference/classes/EnvHelper.md +1 -1
- package/docs/reference/classes/ErrorHelper.md +3 -3
- package/docs/reference/classes/Factory.md +21 -31
- package/docs/reference/classes/FilenameHelper.md +1 -1
- package/docs/reference/classes/GeneralError.md +18 -18
- package/docs/reference/classes/GuardError.md +18 -18
- package/docs/reference/classes/Guards.md +31 -31
- package/docs/reference/classes/HexHelper.md +6 -6
- package/docs/reference/classes/I18n.md +14 -14
- package/docs/reference/classes/Is.md +40 -40
- package/docs/reference/classes/JsonHelper.md +8 -8
- package/docs/reference/classes/NotFoundError.md +18 -18
- package/docs/reference/classes/NotImplementedError.md +18 -18
- package/docs/reference/classes/NotSupportedError.md +18 -18
- package/docs/reference/classes/NumberHelper.md +2 -2
- package/docs/reference/classes/ObjectHelper.md +20 -20
- package/docs/reference/classes/RandomHelper.md +6 -6
- package/docs/reference/classes/SharedStore.md +3 -3
- package/docs/reference/classes/StringHelper.md +23 -23
- package/docs/reference/classes/Uint8ArrayHelper.md +1 -1
- package/docs/reference/classes/UnauthorizedError.md +18 -18
- package/docs/reference/classes/UnprocessableError.md +18 -18
- package/docs/reference/classes/Url.md +8 -8
- package/docs/reference/classes/Urn.md +22 -22
- package/docs/reference/classes/Validation.md +25 -25
- package/docs/reference/classes/ValidationError.md +18 -18
- package/docs/reference/index.md +2 -0
- package/docs/reference/interfaces/IComponent.md +4 -4
- package/docs/reference/interfaces/IError.md +6 -6
- 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/ILocalesIndex.md +1 -1
- package/docs/reference/interfaces/IPatchOperation.md +4 -4
- package/docs/reference/interfaces/IUrlParts.md +6 -6
- package/docs/reference/interfaces/IValidationFailure.md +3 -3
- 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/package.json +4 -4
- 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
|
@@ -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
|
|
|
@@ -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
|
|
|
@@ -14,7 +14,7 @@ Class to help with 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,9 +22,9 @@ Runtime name for the class.
|
|
|
22
22
|
|
|
23
23
|
## Methods
|
|
24
24
|
|
|
25
|
-
### toBytes()
|
|
25
|
+
### toBytes() {#tobytes}
|
|
26
26
|
|
|
27
|
-
> `static` **toBytes**\<`T`\>(`obj`, `format
|
|
27
|
+
> `static` **toBytes**\<`T`\>(`obj`, `format?`): `Uint8Array`
|
|
28
28
|
|
|
29
29
|
Convert an object to bytes.
|
|
30
30
|
|
|
@@ -42,7 +42,7 @@ The object to convert.
|
|
|
42
42
|
|
|
43
43
|
`T` | `undefined`
|
|
44
44
|
|
|
45
|
-
##### format
|
|
45
|
+
##### format?
|
|
46
46
|
|
|
47
47
|
`boolean` = `false`
|
|
48
48
|
|
|
@@ -56,7 +56,7 @@ The object as bytes.
|
|
|
56
56
|
|
|
57
57
|
***
|
|
58
58
|
|
|
59
|
-
### fromBytes()
|
|
59
|
+
### fromBytes() {#frombytes}
|
|
60
60
|
|
|
61
61
|
> `static` **fromBytes**\<`T`\>(`bytes`): `T`
|
|
62
62
|
|
|
@@ -88,7 +88,7 @@ GeneralError if there was an error parsing the JSON.
|
|
|
88
88
|
|
|
89
89
|
***
|
|
90
90
|
|
|
91
|
-
### clone()
|
|
91
|
+
### clone() {#clone}
|
|
92
92
|
|
|
93
93
|
> `static` **clone**\<`T`\>(`obj`): `T`
|
|
94
94
|
|
|
@@ -116,7 +116,7 @@ The objects clone.
|
|
|
116
116
|
|
|
117
117
|
***
|
|
118
118
|
|
|
119
|
-
### merge()
|
|
119
|
+
### merge() {#merge}
|
|
120
120
|
|
|
121
121
|
> `static` **merge**\<`T`, `U`\>(`obj1`, `obj2`): `T` & `U`
|
|
122
122
|
|
|
@@ -154,7 +154,7 @@ The combined deep merge of the objects.
|
|
|
154
154
|
|
|
155
155
|
***
|
|
156
156
|
|
|
157
|
-
### equal()
|
|
157
|
+
### equal() {#equal}
|
|
158
158
|
|
|
159
159
|
> `static` **equal**\<`T`\>(`obj1`, `obj2`, `strictPropertyOrder?`): `boolean`
|
|
160
160
|
|
|
@@ -194,7 +194,7 @@ True is the objects are equal.
|
|
|
194
194
|
|
|
195
195
|
***
|
|
196
196
|
|
|
197
|
-
### propertyGet()
|
|
197
|
+
### propertyGet() {#propertyget}
|
|
198
198
|
|
|
199
199
|
> `static` **propertyGet**\<`T`\>(`obj`, `property`): `T` \| `undefined`
|
|
200
200
|
|
|
@@ -228,7 +228,7 @@ The property.
|
|
|
228
228
|
|
|
229
229
|
***
|
|
230
230
|
|
|
231
|
-
### propertySet()
|
|
231
|
+
### propertySet() {#propertyset}
|
|
232
232
|
|
|
233
233
|
> `static` **propertySet**(`obj`, `property`, `value`): `void`
|
|
234
234
|
|
|
@@ -264,7 +264,7 @@ GeneralError if the property target is not an object.
|
|
|
264
264
|
|
|
265
265
|
***
|
|
266
266
|
|
|
267
|
-
### propertyDelete()
|
|
267
|
+
### propertyDelete() {#propertydelete}
|
|
268
268
|
|
|
269
269
|
> `static` **propertyDelete**(`obj`, `property`): `void`
|
|
270
270
|
|
|
@@ -290,9 +290,9 @@ The property to set
|
|
|
290
290
|
|
|
291
291
|
***
|
|
292
292
|
|
|
293
|
-
### extractProperty()
|
|
293
|
+
### extractProperty() {#extractproperty}
|
|
294
294
|
|
|
295
|
-
> `static` **extractProperty**\<`T`\>(`obj`, `propertyNames`, `removeProperties
|
|
295
|
+
> `static` **extractProperty**\<`T`\>(`obj`, `propertyNames`, `removeProperties?`): `T` \| `undefined`
|
|
296
296
|
|
|
297
297
|
Extract a property from the object, providing alternative names.
|
|
298
298
|
|
|
@@ -316,7 +316,7 @@ The possible names for the property.
|
|
|
316
316
|
|
|
317
317
|
`string` | `string`[]
|
|
318
318
|
|
|
319
|
-
##### removeProperties
|
|
319
|
+
##### removeProperties?
|
|
320
320
|
|
|
321
321
|
`boolean` = `true`
|
|
322
322
|
|
|
@@ -330,7 +330,7 @@ The property if available.
|
|
|
330
330
|
|
|
331
331
|
***
|
|
332
332
|
|
|
333
|
-
### pick()
|
|
333
|
+
### pick() {#pick}
|
|
334
334
|
|
|
335
335
|
> `static` **pick**\<`T`\>(`obj`, `keys?`): `Partial`\<`T`\>
|
|
336
336
|
|
|
@@ -364,7 +364,7 @@ The partial object.
|
|
|
364
364
|
|
|
365
365
|
***
|
|
366
366
|
|
|
367
|
-
### omit()
|
|
367
|
+
### omit() {#omit}
|
|
368
368
|
|
|
369
369
|
> `static` **omit**\<`T`\>(`obj`, `keys?`): `Partial`\<`T`\>
|
|
370
370
|
|
|
@@ -398,7 +398,7 @@ The partial object.
|
|
|
398
398
|
|
|
399
399
|
***
|
|
400
400
|
|
|
401
|
-
### split()
|
|
401
|
+
### split() {#split}
|
|
402
402
|
|
|
403
403
|
> `static` **split**\<`T`\>(`obj`, `keys?`): `object`
|
|
404
404
|
|
|
@@ -440,7 +440,7 @@ The two partial objects.
|
|
|
440
440
|
|
|
441
441
|
***
|
|
442
442
|
|
|
443
|
-
### toExtended()
|
|
443
|
+
### toExtended() {#toextended}
|
|
444
444
|
|
|
445
445
|
> `static` **toExtended**(`obj`): `any`
|
|
446
446
|
|
|
@@ -462,7 +462,7 @@ The object with extended properties.
|
|
|
462
462
|
|
|
463
463
|
***
|
|
464
464
|
|
|
465
|
-
### fromExtended()
|
|
465
|
+
### fromExtended() {#fromextended}
|
|
466
466
|
|
|
467
467
|
> `static` **fromExtended**(`obj`): `any`
|
|
468
468
|
|
|
@@ -484,7 +484,7 @@ The object with regular properties.
|
|
|
484
484
|
|
|
485
485
|
***
|
|
486
486
|
|
|
487
|
-
### removeEmptyProperties()
|
|
487
|
+
### removeEmptyProperties() {#removeemptyproperties}
|
|
488
488
|
|
|
489
489
|
> `static` **removeEmptyProperties**\<`T`\>(`obj`, `options?`): `T`
|
|
490
490
|
|
|
@@ -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,15 +44,15 @@ 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
|
The format of the UUIDv7 string.
|
|
58
58
|
|
|
@@ -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,9 @@ The trimmed string or the original.
|
|
|
58
58
|
|
|
59
59
|
***
|
|
60
60
|
|
|
61
|
-
### kebabCase()
|
|
61
|
+
### kebabCase() {#kebabcase}
|
|
62
62
|
|
|
63
|
-
> `static` **kebabCase**(`input`, `stripInterfacePrefix
|
|
63
|
+
> `static` **kebabCase**(`input`, `stripInterfacePrefix?`): `string`
|
|
64
64
|
|
|
65
65
|
Convert the input string to kebab case.
|
|
66
66
|
|
|
@@ -72,7 +72,7 @@ Convert the input string to kebab case.
|
|
|
72
72
|
|
|
73
73
|
The input to convert.
|
|
74
74
|
|
|
75
|
-
##### stripInterfacePrefix
|
|
75
|
+
##### stripInterfacePrefix?
|
|
76
76
|
|
|
77
77
|
`boolean` = `true`
|
|
78
78
|
|
|
@@ -86,9 +86,9 @@ The kebab case version of the input.
|
|
|
86
86
|
|
|
87
87
|
***
|
|
88
88
|
|
|
89
|
-
### snakeCase()
|
|
89
|
+
### snakeCase() {#snakecase}
|
|
90
90
|
|
|
91
|
-
> `static` **snakeCase**(`input`, `stripInterfacePrefix
|
|
91
|
+
> `static` **snakeCase**(`input`, `stripInterfacePrefix?`): `string`
|
|
92
92
|
|
|
93
93
|
Convert the input string to snake case.
|
|
94
94
|
|
|
@@ -100,7 +100,7 @@ Convert the input string to snake case.
|
|
|
100
100
|
|
|
101
101
|
The input to convert.
|
|
102
102
|
|
|
103
|
-
##### stripInterfacePrefix
|
|
103
|
+
##### stripInterfacePrefix?
|
|
104
104
|
|
|
105
105
|
`boolean` = `true`
|
|
106
106
|
|
|
@@ -114,9 +114,9 @@ The snake case version of the input.
|
|
|
114
114
|
|
|
115
115
|
***
|
|
116
116
|
|
|
117
|
-
### titleCase()
|
|
117
|
+
### titleCase() {#titlecase}
|
|
118
118
|
|
|
119
|
-
> `static` **titleCase**(`input`, `stripInterfacePrefix
|
|
119
|
+
> `static` **titleCase**(`input`, `stripInterfacePrefix?`): `string`
|
|
120
120
|
|
|
121
121
|
Title case all the words.
|
|
122
122
|
|
|
@@ -128,7 +128,7 @@ Title case all the words.
|
|
|
128
128
|
|
|
129
129
|
The input to convert.
|
|
130
130
|
|
|
131
|
-
##### stripInterfacePrefix
|
|
131
|
+
##### stripInterfacePrefix?
|
|
132
132
|
|
|
133
133
|
`boolean` = `true`
|
|
134
134
|
|
|
@@ -142,9 +142,9 @@ The title case version of the input.
|
|
|
142
142
|
|
|
143
143
|
***
|
|
144
144
|
|
|
145
|
-
### pascalCase()
|
|
145
|
+
### pascalCase() {#pascalcase}
|
|
146
146
|
|
|
147
|
-
> `static` **pascalCase**(`input`, `stripInterfacePrefix
|
|
147
|
+
> `static` **pascalCase**(`input`, `stripInterfacePrefix?`): `string`
|
|
148
148
|
|
|
149
149
|
Pascal case all the words.
|
|
150
150
|
|
|
@@ -156,7 +156,7 @@ Pascal case all the words.
|
|
|
156
156
|
|
|
157
157
|
The input to convert.
|
|
158
158
|
|
|
159
|
-
##### stripInterfacePrefix
|
|
159
|
+
##### stripInterfacePrefix?
|
|
160
160
|
|
|
161
161
|
`boolean` = `true`
|
|
162
162
|
|
|
@@ -170,9 +170,9 @@ The pascal case version of the input.
|
|
|
170
170
|
|
|
171
171
|
***
|
|
172
172
|
|
|
173
|
-
### camelCase()
|
|
173
|
+
### camelCase() {#camelcase}
|
|
174
174
|
|
|
175
|
-
> `static` **camelCase**(`input`, `stripInterfacePrefix
|
|
175
|
+
> `static` **camelCase**(`input`, `stripInterfacePrefix?`): `string`
|
|
176
176
|
|
|
177
177
|
Camel case all the words.
|
|
178
178
|
|
|
@@ -184,7 +184,7 @@ Camel case all the words.
|
|
|
184
184
|
|
|
185
185
|
The input to convert.
|
|
186
186
|
|
|
187
|
-
##### stripInterfacePrefix
|
|
187
|
+
##### stripInterfacePrefix?
|
|
188
188
|
|
|
189
189
|
`boolean` = `true`
|
|
190
190
|
|
|
@@ -198,9 +198,9 @@ The camel case version of the input.
|
|
|
198
198
|
|
|
199
199
|
***
|
|
200
200
|
|
|
201
|
-
### wordPath()
|
|
201
|
+
### wordPath() {#wordpath}
|
|
202
202
|
|
|
203
|
-
> `static` **wordPath**(`input`, `stripInterfacePrefix
|
|
203
|
+
> `static` **wordPath**(`input`, `stripInterfacePrefix?`): `string`
|
|
204
204
|
|
|
205
205
|
Convert the words to a path.
|
|
206
206
|
|
|
@@ -212,7 +212,7 @@ Convert the words to a path.
|
|
|
212
212
|
|
|
213
213
|
The input to convert.
|
|
214
214
|
|
|
215
|
-
##### stripInterfacePrefix
|
|
215
|
+
##### stripInterfacePrefix?
|
|
216
216
|
|
|
217
217
|
`boolean` = `true`
|
|
218
218
|
|
|
@@ -226,7 +226,7 @@ The path version of the input.
|
|
|
226
226
|
|
|
227
227
|
***
|
|
228
228
|
|
|
229
|
-
### stripPrefix()
|
|
229
|
+
### stripPrefix() {#stripprefix}
|
|
230
230
|
|
|
231
231
|
> `static` **stripPrefix**(`input`): `string`
|
|
232
232
|
|
|
@@ -248,7 +248,7 @@ The input with any interface prefix stripped.
|
|
|
248
248
|
|
|
249
249
|
***
|
|
250
250
|
|
|
251
|
-
### words()
|
|
251
|
+
### words() {#words}
|
|
252
252
|
|
|
253
253
|
> `static` **words**(`input`): `string`[]
|
|
254
254
|
|
|
@@ -270,7 +270,7 @@ The string split into words.
|
|
|
270
270
|
|
|
271
271
|
***
|
|
272
272
|
|
|
273
|
-
### isUtf8()
|
|
273
|
+
### isUtf8() {#isutf8}
|
|
274
274
|
|
|
275
275
|
> `static` **isUtf8**(`data`): `boolean`
|
|
276
276
|
|