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

package/docs/reference/classes/Base64.md

@@ -5,13 +5,13 @@ Sourced from https://github.com/beatgammit/base64-js.
 
 ## Constructors
 
-### new Base64()
+### Constructor
 
-> **new Base64**(): [`Base64`](Base64.md)
+> **new Base64**(): `Base64`
 
 #### Returns
 
-[`Base64`](Base64.md)
+`Base64`
 
 ## Methods
 
@@ -23,7 +23,9 @@ Get the byte length of the data.
 
 #### Parameters
 
-• **base64**: `string`
+##### base64
+
+`string`
 
 The base64 string.
 
@@ -43,7 +45,9 @@ Convert the base 64 string to a byte array.
 
 #### Parameters
 
-• **base64**: `string`
+##### base64
+
+`string`
 
 The base64 string to convert.
 
@@ -63,7 +67,9 @@ Convert a byte array to base 64.
 
 #### Parameters
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The byte array to convert.
 

package/docs/reference/classes/Base64Url.md

@@ -5,13 +5,13 @@ https://www.rfc-editor.org/rfc/rfc4648#section-5.
 
 ## Constructors
 
-### new Base64Url()
+### Constructor
 
-> **new Base64Url**(): [`Base64Url`](Base64Url.md)
+> **new Base64Url**(): `Base64Url`
 
 #### Returns
 
-[`Base64Url`](Base64Url.md)
+`Base64Url`
 
 ## Methods
 
@@ -23,7 +23,9 @@ Convert the base 64 string to a byte array.
 
 #### Parameters
 
-• **base64Url**: `string`
+##### base64Url
+
+`string`
 
 The base64 url string to convert.
 
@@ -43,7 +45,9 @@ Convert a byte array to base 64 url.
 
 #### Parameters
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The byte array to convert.
 

package/docs/reference/classes/BaseError.md

@@ -25,37 +25,45 @@ Class to handle errors.
 
 ## Constructors
 
-### new BaseError()
+### Constructor
 
-> **new BaseError**(`name`, `source`, `message`, `properties`?, `inner`?): [`BaseError`](BaseError.md)
+> **new BaseError**(`name`, `source`, `message`, `properties?`, `cause?`): `BaseError`
 
 Create a new instance of BaseError.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The name of the error.
 
-• **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`
+##### cause?
 
-The inner error if we have wrapped another error.
+`unknown`
+
+The cause of error if we have wrapped another error.
 
 #### Returns
 
-[`BaseError`](BaseError.md)
+`BaseError`
 
 #### Overrides
 
@@ -83,7 +91,7 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Implementation of
 
@@ -91,33 +99,39 @@ Any additional information for the error.
 
 ***
 
-### inner?
+### cause?
 
-> `optional` **inner**: [`IError`](../interfaces/IError.md)
+> `optional` **cause**: [`IError`](../interfaces/IError.md)
 
-The inner error if there was one.
+The cause of the error.
 
 #### Implementation of
 
-[`IError`](../interfaces/IError.md).[`inner`](../interfaces/IError.md#inner)
+[`IError`](../interfaces/IError.md).[`cause`](../interfaces/IError.md#cause)
+
+#### Overrides
+
+`Error.cause`
 
 ## Methods
 
 ### fromError()
 
-> `static` **fromError**(`err`): [`BaseError`](BaseError.md)
+> `static` **fromError**(`err`): `BaseError`
 
 Construct an error from an existing one.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The existing error.
 
 #### Returns
 
-[`BaseError`](BaseError.md)
+`BaseError`
 
 The new instance.
 
@@ -131,7 +145,9 @@ Flatten an error tree.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The starting error.
 
@@ -151,10 +167,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)
@@ -171,14 +189,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`
@@ -195,14 +217,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`
@@ -219,14 +245,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`
@@ -243,14 +273,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`
@@ -267,14 +301,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`
@@ -291,11 +329,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.
 
@@ -315,14 +357,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`
@@ -331,12 +377,92 @@ True if the error has the name.
 
 ***
 
+### isEmpty()
+
+> `static` **isEmpty**(`err`): `boolean`
+
+Is the error empty, i.e. does it have no message, source, properties, or cause?
+
+#### Parameters
+
+##### err
+
+[`IError`](../interfaces/IError.md)
+
+The error to check for being empty.
+
+#### Returns
+
+`boolean`
+
+True if the error is empty.
+
+***
+
+### isAggregateError()
+
+> `static` **isAggregateError**(`err`): `err is AggregateError`
+
+Is the error an aggregate error.
+
+#### Parameters
+
+##### err
+
+`unknown`
+
+The error to check for being an aggregate error.
+
+#### Returns
+
+`err is AggregateError`
+
+True if the error is an aggregate error.
+
+***
+
+### fromAggregate()
+
+> `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
+
+Convert the aggregate error to an array of errors.
+
+#### Parameters
+
+##### err
+
+`unknown`
+
+The error to convert.
+
+##### includeStackTrace?
+
+`boolean`
+
+Whether to include the error stack in the model, defaults to false.
+
+#### Returns
+
+[`IError`](../interfaces/IError.md)[]
+
+The array of errors.
+
+***
+
 ### 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/BitString.md

@@ -4,43 +4,49 @@ A class to represent a bit string.
 
 ## Constructors
 
-### new BitString()
+### Constructor
 
-> **new BitString**(`numberBits`): [`BitString`](BitString.md)
+> **new BitString**(`numberBits`): `BitString`
 
 Create a new instance of BitString.
 
 #### Parameters
 
-• **numberBits**: `number`
+##### numberBits
+
+`number`
 
 The length of the bit string.
 
 #### Returns
 
-[`BitString`](BitString.md)
+`BitString`
 
 ## Methods
 
 ### fromBits()
 
-> `static` **fromBits**(`bits`, `numberBits`): [`BitString`](BitString.md)
+> `static` **fromBits**(`bits`, `numberBits`): `BitString`
 
 Create a new instance of BitString from a bit array.
 
 #### Parameters
 
-• **bits**: `Uint8Array`
+##### bits
+
+`Uint8Array`
 
 The bits to create the bit string from.
 
-• **numberBits**: `number`
+##### numberBits
+
+`number`
 
 The number of bits in the bit string.
 
 #### Returns
 
-[`BitString`](BitString.md)
+`BitString`
 
 The new instance of BitString.
 
@@ -54,7 +60,9 @@ Get the bit at the given index.
 
 #### Parameters
 
-• **index**: `number`
+##### index
+
+`number`
 
 The index to get the bit for.
 
@@ -78,11 +86,15 @@ Set the bit at the given index.
 
 #### Parameters
 
-• **index**: `number`
+##### index
+
+`number`
 
 The index to set the bit for.
 
-• **value**: `boolean`
+##### value
+
+`boolean`
 
 The value to set the bit to.