@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
|
|
|
@@ -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
|
|
|
@@ -24,7 +24,7 @@ The url string.
|
|
|
24
24
|
|
|
25
25
|
## Properties
|
|
26
26
|
|
|
27
|
-
### CLASS\_NAME
|
|
27
|
+
### CLASS\_NAME {#class_name}
|
|
28
28
|
|
|
29
29
|
> `readonly` `static` **CLASS\_NAME**: `string`
|
|
30
30
|
|
|
@@ -32,7 +32,7 @@ Runtime name for the class.
|
|
|
32
32
|
|
|
33
33
|
## Methods
|
|
34
34
|
|
|
35
|
-
### tryParseExact()
|
|
35
|
+
### tryParseExact() {#tryparseexact}
|
|
36
36
|
|
|
37
37
|
> `static` **tryParseExact**(`url`): `Url` \| `undefined`
|
|
38
38
|
|
|
@@ -54,7 +54,7 @@ The formatted url or undefined if the value is not a url.
|
|
|
54
54
|
|
|
55
55
|
***
|
|
56
56
|
|
|
57
|
-
### guard()
|
|
57
|
+
### guard() {#guard}
|
|
58
58
|
|
|
59
59
|
> `static` **guard**(`source`, `property`, `value`): `asserts value is string`
|
|
60
60
|
|
|
@@ -90,7 +90,7 @@ GuardError If the value does not match the assertion.
|
|
|
90
90
|
|
|
91
91
|
***
|
|
92
92
|
|
|
93
|
-
### validate()
|
|
93
|
+
### validate() {#validate}
|
|
94
94
|
|
|
95
95
|
> `static` **validate**(`property`, `value`, `failures`, `fieldNameResource?`): `value is Url`
|
|
96
96
|
|
|
@@ -130,7 +130,7 @@ The formatted url.
|
|
|
130
130
|
|
|
131
131
|
***
|
|
132
132
|
|
|
133
|
-
### fromURLToParts()
|
|
133
|
+
### fromURLToParts() {#fromurltoparts}
|
|
134
134
|
|
|
135
135
|
> `static` **fromURLToParts**(`url`): [`IUrlParts`](../interfaces/IUrlParts.md)
|
|
136
136
|
|
|
@@ -152,7 +152,7 @@ The formatted url.
|
|
|
152
152
|
|
|
153
153
|
***
|
|
154
154
|
|
|
155
|
-
### fromParts()
|
|
155
|
+
### fromParts() {#fromparts}
|
|
156
156
|
|
|
157
157
|
> `static` **fromParts**(`urlParts`): `Url`
|
|
158
158
|
|
|
@@ -174,7 +174,7 @@ The formatted url.
|
|
|
174
174
|
|
|
175
175
|
***
|
|
176
176
|
|
|
177
|
-
### parts()
|
|
177
|
+
### parts() {#parts}
|
|
178
178
|
|
|
179
179
|
> **parts**(): [`IUrlParts`](../interfaces/IUrlParts.md)
|
|
180
180
|
|
|
@@ -188,7 +188,7 @@ The parts of the url.
|
|
|
188
188
|
|
|
189
189
|
***
|
|
190
190
|
|
|
191
|
-
### toString()
|
|
191
|
+
### toString() {#tostring}
|
|
192
192
|
|
|
193
193
|
> **toString**(): `string`
|
|
194
194
|
|
|
@@ -30,7 +30,7 @@ The specific part of the namespace.
|
|
|
30
30
|
|
|
31
31
|
## Properties
|
|
32
32
|
|
|
33
|
-
### CLASS\_NAME
|
|
33
|
+
### CLASS\_NAME {#class_name}
|
|
34
34
|
|
|
35
35
|
> `readonly` `static` **CLASS\_NAME**: `string`
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ Runtime name for the class.
|
|
|
38
38
|
|
|
39
39
|
## Methods
|
|
40
40
|
|
|
41
|
-
### generateRandom()
|
|
41
|
+
### generateRandom() {#generaterandom}
|
|
42
42
|
|
|
43
43
|
> `static` **generateRandom**(`namespace`): `Urn`
|
|
44
44
|
|
|
@@ -60,7 +60,7 @@ A new Id in URN format.
|
|
|
60
60
|
|
|
61
61
|
***
|
|
62
62
|
|
|
63
|
-
### hasNamespace()
|
|
63
|
+
### hasNamespace() {#hasnamespace}
|
|
64
64
|
|
|
65
65
|
> `static` **hasNamespace**(`urn`, `namespace`): `boolean`
|
|
66
66
|
|
|
@@ -88,7 +88,7 @@ True if the namespace matches.
|
|
|
88
88
|
|
|
89
89
|
***
|
|
90
90
|
|
|
91
|
-
### tryParseExact()
|
|
91
|
+
### tryParseExact() {#tryparseexact}
|
|
92
92
|
|
|
93
93
|
> `static` **tryParseExact**(`urn`): `Urn` \| `undefined`
|
|
94
94
|
|
|
@@ -110,7 +110,7 @@ The formatted urn or undefined if the value is not a urn.
|
|
|
110
110
|
|
|
111
111
|
***
|
|
112
112
|
|
|
113
|
-
### fromValidString()
|
|
113
|
+
### fromValidString() {#fromvalidstring}
|
|
114
114
|
|
|
115
115
|
> `static` **fromValidString**(`urn`): `Urn`
|
|
116
116
|
|
|
@@ -132,7 +132,7 @@ The formatted urn.
|
|
|
132
132
|
|
|
133
133
|
***
|
|
134
134
|
|
|
135
|
-
### addPrefix()
|
|
135
|
+
### addPrefix() {#addprefix}
|
|
136
136
|
|
|
137
137
|
> `static` **addPrefix**(`urn`): `string` \| `undefined`
|
|
138
138
|
|
|
@@ -154,7 +154,7 @@ The urn with a prefix.
|
|
|
154
154
|
|
|
155
155
|
***
|
|
156
156
|
|
|
157
|
-
### guard()
|
|
157
|
+
### guard() {#guard}
|
|
158
158
|
|
|
159
159
|
> `static` **guard**(`source`, `property`, `value`): `asserts value is string`
|
|
160
160
|
|
|
@@ -190,7 +190,7 @@ GuardError If the value does not match the assertion.
|
|
|
190
190
|
|
|
191
191
|
***
|
|
192
192
|
|
|
193
|
-
### validate()
|
|
193
|
+
### validate() {#validate}
|
|
194
194
|
|
|
195
195
|
> `static` **validate**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
|
|
196
196
|
|
|
@@ -230,15 +230,15 @@ The formatted urn.
|
|
|
230
230
|
|
|
231
231
|
***
|
|
232
232
|
|
|
233
|
-
### parts()
|
|
233
|
+
### parts() {#parts}
|
|
234
234
|
|
|
235
|
-
> **parts**(`startIndex
|
|
235
|
+
> **parts**(`startIndex?`): `string`[]
|
|
236
236
|
|
|
237
237
|
Get the parts.
|
|
238
238
|
|
|
239
239
|
#### Parameters
|
|
240
240
|
|
|
241
|
-
##### startIndex
|
|
241
|
+
##### startIndex?
|
|
242
242
|
|
|
243
243
|
`number` = `0`
|
|
244
244
|
|
|
@@ -252,7 +252,7 @@ The parts.
|
|
|
252
252
|
|
|
253
253
|
***
|
|
254
254
|
|
|
255
|
-
### namespaceIdentifier()
|
|
255
|
+
### namespaceIdentifier() {#namespaceidentifier}
|
|
256
256
|
|
|
257
257
|
> **namespaceIdentifier**(): `string`
|
|
258
258
|
|
|
@@ -266,7 +266,7 @@ The namespace identifier.
|
|
|
266
266
|
|
|
267
267
|
***
|
|
268
268
|
|
|
269
|
-
### namespaceMethod()
|
|
269
|
+
### namespaceMethod() {#namespacemethod}
|
|
270
270
|
|
|
271
271
|
> **namespaceMethod**(): `string`
|
|
272
272
|
|
|
@@ -280,15 +280,15 @@ The namespace method.
|
|
|
280
280
|
|
|
281
281
|
***
|
|
282
282
|
|
|
283
|
-
### namespaceSpecificParts()
|
|
283
|
+
### namespaceSpecificParts() {#namespacespecificparts}
|
|
284
284
|
|
|
285
|
-
> **namespaceSpecificParts**(`startIndex
|
|
285
|
+
> **namespaceSpecificParts**(`startIndex?`): `string`[]
|
|
286
286
|
|
|
287
287
|
Get the namespace specific parts.
|
|
288
288
|
|
|
289
289
|
#### Parameters
|
|
290
290
|
|
|
291
|
-
##### startIndex
|
|
291
|
+
##### startIndex?
|
|
292
292
|
|
|
293
293
|
`number` = `0`
|
|
294
294
|
|
|
@@ -302,15 +302,15 @@ The namespace specific parts.
|
|
|
302
302
|
|
|
303
303
|
***
|
|
304
304
|
|
|
305
|
-
### namespaceSpecific()
|
|
305
|
+
### namespaceSpecific() {#namespacespecific}
|
|
306
306
|
|
|
307
|
-
> **namespaceSpecific**(`startIndex
|
|
307
|
+
> **namespaceSpecific**(`startIndex?`): `string`
|
|
308
308
|
|
|
309
309
|
Get the namespace specific.
|
|
310
310
|
|
|
311
311
|
#### Parameters
|
|
312
312
|
|
|
313
|
-
##### startIndex
|
|
313
|
+
##### startIndex?
|
|
314
314
|
|
|
315
315
|
`number` = `0`
|
|
316
316
|
|
|
@@ -324,15 +324,15 @@ The namespace specific.
|
|
|
324
324
|
|
|
325
325
|
***
|
|
326
326
|
|
|
327
|
-
### toString()
|
|
327
|
+
### toString() {#tostring}
|
|
328
328
|
|
|
329
|
-
> **toString**(`omitPrefix
|
|
329
|
+
> **toString**(`omitPrefix?`): `string`
|
|
330
330
|
|
|
331
331
|
Convert the parts in to a full string.
|
|
332
332
|
|
|
333
333
|
#### Parameters
|
|
334
334
|
|
|
335
|
-
##### omitPrefix
|
|
335
|
+
##### omitPrefix?
|
|
336
336
|
|
|
337
337
|
`boolean` = `true`
|
|
338
338
|
|