@twin.org/core 0.0.2-next.8 → 0.0.2

package/docs/reference/classes/UnprocessableError.md

@@ -26,7 +26,7 @@ The source of the error.
 
 `string`
 
-The message as a code.
+The message as an i18n key.
 
 ##### properties?
 
@@ -48,9 +48,9 @@ The cause of the error if we have wrapped another error.
 
 ## Properties
 
-### source?
+### source? {#source}
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
 The source of the error.
 
@@ -60,9 +60,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -76,9 +76,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.
 
@@ -88,7 +88,7 @@ The cause of the error.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -96,7 +96,7 @@ Runtime name for the class.
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
 
@@ -122,7 +122,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -148,9 +148,9 @@ The list of all internal errors.
 
 ***
 
-### expand()
+### expand() {#expand}
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -158,13 +158,13 @@ Expand an error tree.
 
 ##### errors
 
-The list of errors to expand.
+[`IError`](../interfaces/IError.md)[] \| `undefined`
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+The list of errors to expand.
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 
@@ -174,7 +174,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -190,9 +190,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -206,7 +206,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -222,9 +222,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -238,7 +238,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -254,9 +254,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -270,7 +270,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -286,9 +286,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -302,7 +302,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -318,9 +318,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -334,7 +334,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -366,7 +366,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -382,9 +382,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -398,7 +398,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -424,7 +424,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -450,7 +450,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -482,7 +482,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 

package/docs/reference/classes/Url.md

@@ -22,11 +22,19 @@ The url string.
 
 `Url`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### tryParseExact()
+### tryParseExact() {#tryparseexact}
 
-> `static` **tryParseExact**(`url`): `undefined` \| `Url`
+> `static` **tryParseExact**(`url`): `Url` \| `undefined`
 
 Try and parse a string into the url parts.
 
@@ -40,13 +48,13 @@ The url to parse.
 
 #### Returns
 
-`undefined` \| `Url`
+`Url` \| `undefined`
 
 The formatted url or undefined if the value is not a url.
 
 ***
 
-### guard()
+### guard() {#guard}
 
 > `static` **guard**(`source`, `property`, `value`): `asserts value is string`
 
@@ -82,9 +90,9 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### validate()
+### validate() {#validate}
 
-> `static` **validate**(`property`, `value`, `failures`): `value is Url`
+> `static` **validate**(`property`, `value`, `failures`, `fieldNameResource?`): `value is Url`
 
 Validate a string as a Url.
 
@@ -108,6 +116,12 @@ The url to parse.
 
 The list of failures to add to.
 
+##### fieldNameResource?
+
+`string`
+
+The optional human readable name for the field as an i18 resource.
+
 #### Returns
 
 `value is Url`
@@ -116,7 +130,7 @@ The formatted url.
 
 ***
 
-### fromURLToParts()
+### fromURLToParts() {#fromurltoparts}
 
 > `static` **fromURLToParts**(`url`): [`IUrlParts`](../interfaces/IUrlParts.md)
 
@@ -138,7 +152,7 @@ The formatted url.
 
 ***
 
-### fromParts()
+### fromParts() {#fromparts}
 
 > `static` **fromParts**(`urlParts`): `Url`
 
@@ -160,7 +174,7 @@ The formatted url.
 
 ***
 
-### parts()
+### parts() {#parts}
 
 > **parts**(): [`IUrlParts`](../interfaces/IUrlParts.md)
 
@@ -174,7 +188,7 @@ The parts of the url.
 
 ***
 
-### toString()
+### toString() {#tostring}
 
 > **toString**(): `string`
 

package/docs/reference/classes/Urn.md

@@ -20,17 +20,25 @@ The identifier for the namespace.
 
 ##### namespaceSpecific
 
-The specific part of the namespace.
+`string` \| `string`[]
 
-`string` | `string`[]
+The specific part of the namespace.
 
 #### Returns
 
 `Urn`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### generateRandom()
+### generateRandom() {#generaterandom}
 
 > `static` **generateRandom**(`namespace`): `Urn`
 
@@ -52,7 +60,7 @@ A new Id in URN format.
 
 ***
 
-### hasNamespace()
+### hasNamespace() {#hasnamespace}
 
 > `static` **hasNamespace**(`urn`, `namespace`): `boolean`
 
@@ -80,9 +88,9 @@ True if the namespace matches.
 
 ***
 
-### tryParseExact()
+### tryParseExact() {#tryparseexact}
 
-> `static` **tryParseExact**(`urn`): `undefined` \| `Urn`
+> `static` **tryParseExact**(`urn`): `Urn` \| `undefined`
 
 Try and parse a string into the urn parts.
 
@@ -96,13 +104,13 @@ The urn to parse.
 
 #### Returns
 
-`undefined` \| `Urn`
+`Urn` \| `undefined`
 
 The formatted urn or undefined if the value is not a urn.
 
 ***
 
-### fromValidString()
+### fromValidString() {#fromvalidstring}
 
 > `static` **fromValidString**(`urn`): `Urn`
 
@@ -124,9 +132,9 @@ The formatted urn.
 
 ***
 
-### addPrefix()
+### addPrefix() {#addprefix}
 
-> `static` **addPrefix**(`urn`): `undefined` \| `string`
+> `static` **addPrefix**(`urn`): `string` \| `undefined`
 
 Add a urn: prefix if there isn't one already.
 
@@ -140,13 +148,13 @@ The urn string to add a prefix to.
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The urn with a prefix.
 
 ***
 
-### guard()
+### guard() {#guard}
 
 > `static` **guard**(`source`, `property`, `value`): `asserts value is string`
 
@@ -182,9 +190,9 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### validate()
+### validate() {#validate}
 
-> `static` **validate**(`property`, `value`, `failures`): `value is string`
+> `static` **validate**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
 Validate a string as a Urn.
 
@@ -208,6 +216,12 @@ The urn to parse.
 
 The list of failures to add to.
 
+##### fieldNameResource?
+
+`string`
+
+The optional human readable name for the field as an i18 resource.
+
 #### Returns
 
 `value is string`
@@ -216,15 +230,15 @@ The formatted urn.
 
 ***
 
-### parts()
+### parts() {#parts}
 
-> **parts**(`startIndex`): `string`[]
+> **parts**(`startIndex?`): `string`[]
 
 Get the parts.
 
 #### Parameters
 
-##### startIndex
+##### startIndex?
 
 `number` = `0`
 
@@ -238,7 +252,7 @@ The parts.
 
 ***
 
-### namespaceIdentifier()
+### namespaceIdentifier() {#namespaceidentifier}
 
 > **namespaceIdentifier**(): `string`
 
@@ -252,7 +266,7 @@ The namespace identifier.
 
 ***
 
-### namespaceMethod()
+### namespaceMethod() {#namespacemethod}
 
 > **namespaceMethod**(): `string`
 
@@ -266,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`
 
@@ -288,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`
 
@@ -310,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`