@twin.org/core 0.0.3-next.3 → 0.0.3-next.31

package/docs/reference/classes/Urn.md

@@ -20,9 +20,9 @@ The identifier for the namespace.
 
 ##### namespaceSpecific
 
-The specific part of the namespace.
+`string` \| `string`[]
 
-`string` | `string`[]
+The specific part of the namespace.
 
 #### Returns
 
@@ -30,7 +30,7 @@ The specific part of the namespace.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -38,7 +38,7 @@ Runtime name for the class.
 
 ## Methods
 
-### generateRandom()
+### generateRandom() {#generaterandom}
 
 > `static` **generateRandom**(`namespace`): `Urn`
 
@@ -60,7 +60,7 @@ A new Id in URN format.
 
 ***
 
-### hasNamespace()
+### hasNamespace() {#hasnamespace}
 
 > `static` **hasNamespace**(`urn`, `namespace`): `boolean`
 
@@ -88,7 +88,7 @@ True if the namespace matches.
 
 ***
 
-### tryParseExact()
+### tryParseExact() {#tryparseexact}
 
 > `static` **tryParseExact**(`urn`): `Urn` \| `undefined`
 
@@ -110,7 +110,7 @@ The formatted urn or undefined if the value is not a urn.
 
 ***
 
-### fromValidString()
+### fromValidString() {#fromvalidstring}
 
 > `static` **fromValidString**(`urn`): `Urn`
 
@@ -132,7 +132,7 @@ The formatted urn.
 
 ***
 
-### addPrefix()
+### addPrefix() {#addprefix}
 
 > `static` **addPrefix**(`urn`): `string` \| `undefined`
 
@@ -154,7 +154,7 @@ The urn with a prefix.
 
 ***
 
-### guard()
+### guard() {#guard}
 
 > `static` **guard**(`source`, `property`, `value`): `asserts value is string`
 
@@ -190,7 +190,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### validate()
+### validate() {#validate}
 
 > `static` **validate**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
@@ -230,15 +230,15 @@ The formatted urn.
 
 ***
 
-### parts()
+### parts() {#parts}
 
-> **parts**(`startIndex`): `string`[]
+> **parts**(`startIndex?`): `string`[]
 
 Get the parts.
 
 #### Parameters
 
-##### startIndex
+##### startIndex?
 
 `number` = `0`
 
@@ -252,7 +252,7 @@ The parts.
 
 ***
 
-### namespaceIdentifier()
+### namespaceIdentifier() {#namespaceidentifier}
 
 > **namespaceIdentifier**(): `string`
 
@@ -266,7 +266,7 @@ The namespace identifier.
 
 ***
 
-### namespaceMethod()
+### namespaceMethod() {#namespacemethod}
 
 > **namespaceMethod**(): `string`
 
@@ -280,15 +280,15 @@ The namespace method.
 
 ***
 
-### namespaceSpecificParts()
+### namespaceSpecificParts() {#namespacespecificparts}
 
-> **namespaceSpecificParts**(`startIndex`): `string`[]
+> **namespaceSpecificParts**(`startIndex?`): `string`[]
 
 Get the namespace specific parts.
 
 #### Parameters
 
-##### startIndex
+##### startIndex?
 
 `number` = `0`
 
@@ -302,15 +302,15 @@ The namespace specific parts.
 
 ***
 
-### namespaceSpecific()
+### namespaceSpecific() {#namespacespecific}
 
-> **namespaceSpecific**(`startIndex`): `string`
+> **namespaceSpecific**(`startIndex?`): `string`
 
 Get the namespace specific.
 
 #### Parameters
 
-##### startIndex
+##### startIndex?
 
 `number` = `0`
 
@@ -324,15 +324,15 @@ The namespace specific.
 
 ***
 
-### toString()
+### toString() {#tostring}
 
-> **toString**(`omitPrefix`): `string`
+> **toString**(`omitPrefix?`): `string`
 
 Convert the parts in to a full string.
 
 #### Parameters
 
-##### omitPrefix
+##### omitPrefix?
 
 `boolean` = `true`
 

package/docs/reference/classes/Validation.md

@@ -14,7 +14,7 @@ Class to handle validation operations.
 
 ## Methods
 
-### empty()
+### empty() {#empty}
 
 > `static` **empty**(`property`, `value`, `failures`, `fieldNameResource?`): value is null \| undefined
 
@@ -54,7 +54,7 @@ True if the value is a empty.
 
 ***
 
-### notEmpty()
+### notEmpty() {#notempty}
 
 > `static` **notEmpty**(`property`, `value`, `failures`, `fieldNameResource?`): `boolean`
 
@@ -94,7 +94,7 @@ True if the value is a not empty.
 
 ***
 
-### string()
+### string() {#string}
 
 > `static` **string**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is string`
 
@@ -156,7 +156,7 @@ True if the value is a valid string.
 
 ***
 
-### stringValue()
+### stringValue() {#stringvalue}
 
 > `static` **stringValue**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is string`
 
@@ -212,7 +212,7 @@ True if the value is a valid string.
 
 ***
 
-### number()
+### number() {#number}
 
 > `static` **number**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is number`
 
@@ -268,7 +268,7 @@ True if the value is a valid number.
 
 ***
 
-### integer()
+### integer() {#integer}
 
 > `static` **integer**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is number`
 
@@ -324,7 +324,7 @@ True if the value is a valid integer.
 
 ***
 
-### bigint()
+### bigint() {#bigint}
 
 > `static` **bigint**(`property`, `value`, `failures`, `fieldNameResource?`, `options?`): `value is bigint`
 
@@ -380,7 +380,7 @@ True if the value is a valid bigint.
 
 ***
 
-### boolean()
+### boolean() {#boolean}
 
 > `static` **boolean**(`property`, `value`, `failures`, `fieldNameResource?`): `value is boolean`
 
@@ -420,7 +420,7 @@ True if the value is a boolean.
 
 ***
 
-### date()
+### date() {#date}
 
 > `static` **date**(`property`, `value`, `failures`, `fieldNameResource?`): `value is Date`
 
@@ -460,7 +460,7 @@ True if the value is a date.
 
 ***
 
-### dateString()
+### dateString() {#datestring}
 
 > `static` **dateString**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
@@ -500,7 +500,7 @@ True if the value is a date.
 
 ***
 
-### dateTimeString()
+### dateTimeString() {#datetimestring}
 
 > `static` **dateTimeString**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
@@ -540,7 +540,7 @@ True if the value is a date/time.
 
 ***
 
-### timeString()
+### timeString() {#timestring}
 
 > `static` **timeString**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
@@ -580,7 +580,7 @@ True if the value is a time.
 
 ***
 
-### timestampMilliseconds()
+### timestampMilliseconds() {#timestampmilliseconds}
 
 > `static` **timestampMilliseconds**(`property`, `value`, `failures`, `fieldNameResource?`): `value is number`
 
@@ -620,7 +620,7 @@ True if the value is a timestamp in milliseconds.
 
 ***
 
-### timestampSeconds()
+### timestampSeconds() {#timestampseconds}
 
 > `static` **timestampSeconds**(`property`, `value`, `failures`, `fieldNameResource?`): `value is number`
 
@@ -660,7 +660,7 @@ True if the value is a timestamp in seconds.
 
 ***
 
-### object()
+### object() {#object}
 
 > `static` **object**\<`T`\>(`property`, `value`, `failures`, `fieldNameResource?`): `value is T`
 
@@ -706,7 +706,7 @@ True if the value is a object.
 
 ***
 
-### array()
+### array() {#array}
 
 > `static` **array**\<`T`\>(`property`, `value`, `failures`, `fieldNameResource?`): `value is T[]`
 
@@ -752,7 +752,7 @@ True if the value is an array.
 
 ***
 
-### arrayValue()
+### arrayValue() {#arrayvalue}
 
 > `static` **arrayValue**\<`T`\>(`property`, `value`, `failures`, `fieldNameResource?`): `value is T[]`
 
@@ -798,7 +798,7 @@ True if the value is an array with at least one element.
 
 ***
 
-### arrayOneOf()
+### arrayOneOf() {#arrayoneof}
 
 > `static` **arrayOneOf**\<`T`\>(`property`, `value`, `options`, `failures`, `fieldNameResource?`): `value is T`
 
@@ -850,7 +850,7 @@ True if the value is one of the items in the options.
 
 ***
 
-### uint8Array()
+### uint8Array() {#uint8array}
 
 > `static` **uint8Array**(`property`, `value`, `failures`, `fieldNameResource?`): `value is Uint8Array<ArrayBufferLike>`
 
@@ -890,7 +890,7 @@ True if the value is a Uint8Array.
 
 ***
 
-### json()
+### json() {#json}
 
 > `static` **json**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
@@ -930,7 +930,7 @@ True if the value is valid JSON.
 
 ***
 
-### email()
+### email() {#email}
 
 > `static` **email**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
@@ -970,7 +970,7 @@ True if the value is a valid looking e-mail.
 
 ***
 
-### asValidationError()
+### asValidationError() {#asvalidationerror}
 
 > `static` **asValidationError**(`source`, `objectName`, `failures`): `void`
 
@@ -1006,9 +1006,9 @@ ValidationError From the converted failures.
 
 ***
 
-### toPropertyMap()
+### toPropertyMap() {#topropertymap}
 
-> `static` **toPropertyMap**(`failures`, `propertyMap`, `clearMap`): `void`
+> `static` **toPropertyMap**(`failures`, `propertyMap`, `clearMap?`): `void`
 
 Map a list of failures to their properties in a map.
 
@@ -1024,7 +1024,7 @@ The validation failures to combine into the map for the properties.
 
 The map to add the failures to.
 
-##### clearMap
+##### clearMap?
 
 `boolean` = `true`
 

package/docs/reference/classes/ValidationError.md

@@ -44,9 +44,9 @@ The validation failures.
 
 ## Properties
 
-### source?
+### source? {#source}
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
 The source of the error.
 
@@ -56,9 +56,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -72,9 +72,9 @@ Any additional information for the error.
 
 ***
 
-### cause?
+### cause? {#cause}
 
-> `optional` **cause**: [`IError`](../interfaces/IError.md)
+> `optional` **cause?**: [`IError`](../interfaces/IError.md)
 
 The cause of the error.
 
@@ -84,7 +84,7 @@ The cause of the error.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -92,7 +92,7 @@ Runtime name for the class.s
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
 
@@ -118,7 +118,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -144,7 +144,7 @@ The list of all internal errors.
 
 ***
 
-### expand()
+### expand() {#expand}
 
 > `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
@@ -154,9 +154,9 @@ Expand an error tree.
 
 ##### errors
 
-The list of errors to expand.
+[`IError`](../interfaces/IError.md)[] \| `undefined`
 
-[`IError`](../interfaces/IError.md)[] | `undefined`
+The list of errors to expand.
 
 #### Returns
 
@@ -170,7 +170,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -186,9 +186,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -202,7 +202,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -218,9 +218,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -234,7 +234,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -250,9 +250,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -266,7 +266,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -282,9 +282,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -298,7 +298,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -314,9 +314,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -330,7 +330,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -362,7 +362,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -378,9 +378,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -394,7 +394,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -420,7 +420,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -446,7 +446,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -478,7 +478,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 

package/docs/reference/index.md

@@ -61,6 +61,8 @@
 - [CoerceType](type-aliases/CoerceType.md)
 - [CompressionType](type-aliases/CompressionType.md)
 - [ObjectOrArray](type-aliases/ObjectOrArray.md)
+- [SingleOccurrenceArrayDepthHelper](type-aliases/SingleOccurrenceArrayDepthHelper.md)
+- [SingleOccurrenceArray](type-aliases/SingleOccurrenceArray.md)
 
 ## Variables
 

package/docs/reference/interfaces/IComponent.md

@@ -4,7 +4,7 @@ Interface describing a component which can be bootstrapped, started and stopped.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -18,7 +18,7 @@ The class name of the component.
 
 ***
 
-### bootstrap()?
+### bootstrap()? {#bootstrap}
 
 > `optional` **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
 
@@ -40,7 +40,7 @@ True if the bootstrapping process was successful.
 
 ***
 
-### start()?
+### start()? {#start}
 
 > `optional` **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
@@ -62,7 +62,7 @@ Nothing.
 
 ***
 
-### stop()?
+### stop()? {#stop}
 
 > `optional` **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>