@twin.org/core 0.0.1-next.9 → 0.0.2-next.3

package/docs/reference/classes/UnprocessableError.md

@@ -8,37 +8,43 @@ Class to handle errors when some data can not be processed.
 
 ## Constructors
 
-### new UnprocessableError()
+### Constructor
 
-> **new UnprocessableError**(`source`, `message`, `properties`?, `inner`?): [`UnprocessableError`](UnprocessableError.md)
+> **new UnprocessableError**(`source`, `message`, `properties?`, `inner?`): `UnprocessableError`
 
 Create a new instance of UnprocessableError.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message as a code.
 
-• **properties?**
+##### properties?
 
 Any additional information for the error.
 
-• **inner?**: `unknown`
+##### inner?
+
+`unknown`
 
 The inner error if we have wrapped another error.
 
 #### Returns
 
-[`UnprocessableError`](UnprocessableError.md)
+`UnprocessableError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -62,7 +68,7 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Inherited from
 
@@ -98,7 +104,9 @@ Construct an error from an existing one.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The existing error.
 
@@ -122,7 +130,9 @@ Flatten an error tree.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The starting error.
 
@@ -146,10 +156,12 @@ Expand an error tree.
 
 #### Parameters
 
-• **errors**: `undefined` \| [`IError`](../interfaces/IError.md)[]
+##### errors
 
 The list of errors to expand.
 
+`undefined` | [`IError`](../interfaces/IError.md)[]
+
 #### Returns
 
 `undefined` \| [`IError`](../interfaces/IError.md)
@@ -170,14 +182,18 @@ Test to see if the error has the specified error name.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **name**: `string` \| `RegExp`
+##### name
 
 The name to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -198,14 +214,18 @@ Test to see if the error has the specified error message.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **message**: `string` \| `RegExp`
+##### message
 
 The message to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -226,14 +246,18 @@ Test to see if the error has the specified error code.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **code**: `string` \| `RegExp`
+##### code
 
 The code to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `boolean`
@@ -254,14 +278,18 @@ Test to see if any of the errors or children have the given error name.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **name**: `string` \| `RegExp`
+##### name
 
 The name to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -282,14 +310,18 @@ Test to see if any of the errors or children have the given error message.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **message**: `string` \| `RegExp`
+##### message
 
 The message to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -310,11 +342,15 @@ Test to see if any of the errors or children are from a specific class.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **cls**: `string`
+##### cls
+
+`string`
 
 The class to check for.
 
@@ -338,14 +374,18 @@ Test to see if any of the errors or children have the given error code.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **code**: `string` \| `RegExp`
+##### code
 
 The code to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -358,12 +398,46 @@ True if the error has the name.
 
 ***
 
+### isEmpty()
+
+> `static` **isEmpty**(`err`): `boolean`
+
+Is the error empty.
+
+#### Parameters
+
+##### err
+
+[`IError`](../interfaces/IError.md)
+
+The error to check for being empty.
+
+#### Returns
+
+`boolean`
+
+True if the error is empty.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isEmpty`](BaseError.md#isempty)
+
+***
+
 ### toJsonObject()
 
-> **toJsonObject**(): [`IError`](../interfaces/IError.md)
+> **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 
 Serialize the error to the error model.
 
+#### Parameters
+
+##### includeStackTrace?
+
+`boolean`
+
+Whether to include the error stack in the model, defaults to false.
+
 #### Returns
 
 [`IError`](../interfaces/IError.md)

package/docs/reference/classes/Url.md

@@ -4,39 +4,43 @@ Class to help with urls.
 
 ## Constructors
 
-### new Url()
+### Constructor
 
-> **new Url**(`url`): [`Url`](Url.md)
+> **new Url**(`url`): `Url`
 
 Create a new instance of Url.
 
 #### Parameters
 
-• **url**: `string`
+##### url
+
+`string`
 
 The url string.
 
 #### Returns
 
-[`Url`](Url.md)
+`Url`
 
 ## Methods
 
 ### tryParseExact()
 
-> `static` **tryParseExact**(`url`): `undefined` \| [`Url`](Url.md)
+> `static` **tryParseExact**(`url`): `undefined` \| `Url`
 
 Try and parse a string into the url parts.
 
 #### Parameters
 
-• **url**: `unknown`
+##### url
+
+`unknown`
 
 The url to parse.
 
 #### Returns
 
-`undefined` \| [`Url`](Url.md)
+`undefined` \| `Url`
 
 The formatted url or undefined if the value is not a url.
 
@@ -50,15 +54,21 @@ Parse a string into the url parts.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The url to parse.
 
@@ -80,15 +90,21 @@ Validate a string as a Url.
 
 #### Parameters
 
-• **property**: `string`
+##### property
+
+`string`
 
 Throw an exception if the url property is invalid.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The url to parse.
 
-• **failures**: [`IValidationFailure`](../interfaces/IValidationFailure.md)[]
+##### failures
+
+[`IValidationFailure`](../interfaces/IValidationFailure.md)[]
 
 The list of failures to add to.
 
@@ -108,7 +124,9 @@ Construct a url from a URL.
 
 #### Parameters
 
-• **url**: `URL`
+##### url
+
+`URL`
 
 The url to construct from.
 
@@ -122,19 +140,21 @@ The formatted url.
 
 ### fromParts()
 
-> `static` **fromParts**(`urlParts`): [`Url`](Url.md)
+> `static` **fromParts**(`urlParts`): `Url`
 
 Construct a url from valid parts.
 
 #### Parameters
 
-• **urlParts**: [`IUrlParts`](../interfaces/IUrlParts.md)
+##### urlParts
+
+[`IUrlParts`](../interfaces/IUrlParts.md)
 
 The url to create the parts from.
 
 #### Returns
 
-[`Url`](Url.md)
+`Url`
 
 The formatted url.
 

package/docs/reference/classes/Urn.md

@@ -4,43 +4,49 @@ Class to help with urns.
 
 ## Constructors
 
-### new Urn()
+### Constructor
 
-> **new Urn**(`namespaceIdentifier`, `namespaceSpecific`): [`Urn`](Urn.md)
+> **new Urn**(`namespaceIdentifier`, `namespaceSpecific`): `Urn`
 
 Create a new instance of Urn.
 
 #### Parameters
 
-• **namespaceIdentifier**: `string`
+##### namespaceIdentifier
+
+`string`
 
 The identifier for the namespace.
 
-• **namespaceSpecific**: `string` \| `string`[]
+##### namespaceSpecific
 
 The specific part of the namespace.
 
+`string` | `string`[]
+
 #### Returns
 
-[`Urn`](Urn.md)
+`Urn`
 
 ## Methods
 
 ### generateRandom()
 
-> `static` **generateRandom**(`namespace`): [`Urn`](Urn.md)
+> `static` **generateRandom**(`namespace`): `Urn`
 
 Generate a random identifier with 32 byte id.
 
 #### Parameters
 
-• **namespace**: `string`
+##### namespace
+
+`string`
 
 The prefix for the urn.
 
 #### Returns
 
-[`Urn`](Urn.md)
+`Urn`
 
 A new Id in URN format.
 
@@ -54,11 +60,15 @@ Does the provided urn match the namespace.
 
 #### Parameters
 
-• **urn**: `string`
+##### urn
+
+`string`
 
 The urn to check.
 
-• **namespace**: `string`
+##### namespace
+
+`string`
 
 The namespace to match.
 
@@ -72,19 +82,21 @@ True if the namespace matches.
 
 ### tryParseExact()
 
-> `static` **tryParseExact**(`urn`): `undefined` \| [`Urn`](Urn.md)
+> `static` **tryParseExact**(`urn`): `undefined` \| `Urn`
 
 Try and parse a string into the urn parts.
 
 #### Parameters
 
-• **urn**: `unknown`
+##### urn
+
+`unknown`
 
 The urn to parse.
 
 #### Returns
 
-`undefined` \| [`Urn`](Urn.md)
+`undefined` \| `Urn`
 
 The formatted urn or undefined if the value is not a urn.
 
@@ -92,19 +104,21 @@ The formatted urn or undefined if the value is not a urn.
 
 ### fromValidString()
 
-> `static` **fromValidString**(`urn`): [`Urn`](Urn.md)
+> `static` **fromValidString**(`urn`): `Urn`
 
 Construct a urn from a string that has already been validated.
 
 #### Parameters
 
-• **urn**: `string`
+##### urn
+
+`string`
 
 The urn to parse.
 
 #### Returns
 
-[`Urn`](Urn.md)
+`Urn`
 
 The formatted urn.
 
@@ -118,7 +132,9 @@ Add a urn: prefix if there isn't one already.
 
 #### Parameters
 
-• **urn**: `unknown`
+##### urn
+
+`unknown`
 
 The urn string to add a prefix to.
 
@@ -138,15 +154,21 @@ Parse a string into the urn parts.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The urn to parse.
 
@@ -168,15 +190,21 @@ Validate a string as a Urn.
 
 #### Parameters
 
-• **property**: `string`
+##### property
+
+`string`
 
 Throw an exception if the urn property is invalid.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The urn to parse.
 
-• **failures**: [`IValidationFailure`](../interfaces/IValidationFailure.md)[]
+##### failures
+
+[`IValidationFailure`](../interfaces/IValidationFailure.md)[]
 
 The list of failures to add to.
 
@@ -196,7 +224,9 @@ Get the parts.
 
 #### Parameters
 
-• **startIndex**: `number` = `0`
+##### startIndex
+
+`number` = `0`
 
 The index to start from, defaults to 0.
 
@@ -244,7 +274,9 @@ Get the namespace specific parts.
 
 #### Parameters
 
-• **startIndex**: `number` = `0`
+##### startIndex
+
+`number` = `0`
 
 The index to start from, defaults to 0.
 
@@ -264,7 +296,9 @@ Get the namespace specific.
 
 #### Parameters
 
-• **startIndex**: `number` = `0`
+##### startIndex
+
+`number` = `0`
 
 The index to start from, defaults to 0.
 
@@ -284,7 +318,9 @@ Convert the parts in to a full string.
 
 #### Parameters
 
-• **omitPrefix**: `boolean` = `true`
+##### omitPrefix
+
+`boolean` = `true`
 
 Omit the urn: prefix from the string.