@twin.org/core 0.0.1-next.6 → 0.0.1-next.60

package/docs/reference/classes/ConflictError.md

@@ -8,41 +8,51 @@ Class to handle errors which are triggered by conflicting data.
 
 ## Constructors
 
-### new ConflictError()
+### Constructor
 
-> **new ConflictError**(`source`, `message`, `conflictId`?, `conflicts`?, `inner`?): [`ConflictError`](ConflictError.md)
+> **new ConflictError**(`source`, `message`, `conflictId?`, `conflicts?`, `inner?`): `ConflictError`
 
 Create a new instance of ConflictError.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message as a code.
 
-• **conflictId?**: `string`
+##### conflictId?
+
+`string`
 
 The id that has conflicts.
 
-• **conflicts?**: `string`[]
+##### conflicts?
+
+`string`[]
 
 The conflicts that occurred.
 
-• **inner?**: `unknown`
+##### inner?
+
+`unknown`
 
 The inner error if we have wrapped another error.
 
 #### Returns
 
-[`ConflictError`](ConflictError.md)
+`ConflictError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -66,7 +76,7 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Inherited from
 
@@ -102,7 +112,9 @@ Construct an error from an existing one.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The existing error.
 
@@ -126,7 +138,9 @@ Flatten an error tree.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The starting error.
 
@@ -150,10 +164,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)
@@ -174,14 +190,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`
@@ -202,14 +222,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`
@@ -230,14 +254,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`
@@ -258,14 +286,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`
@@ -286,14 +318,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`
@@ -314,11 +350,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.
 
@@ -342,14 +382,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`
@@ -364,10 +408,18 @@ True if the error has the name.
 
 ### 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/Converter.md

@@ -4,33 +4,39 @@ Convert arrays to and from different formats.
 
 ## Constructors
 
-### new Converter()
+### Constructor
 
-> **new Converter**(): [`Converter`](Converter.md)
+> **new Converter**(): `Converter`
 
 #### Returns
 
-[`Converter`](Converter.md)
+`Converter`
 
 ## Methods
 
 ### bytesToUtf8()
 
-> `static` **bytesToUtf8**(`array`, `startIndex`?, `length`?): `string`
+> `static` **bytesToUtf8**(`array`, `startIndex?`, `length?`): `string`
 
 Encode a raw array to UTF8 string.
 
 #### Parameters
 
-• **array**: `ArrayLike`\<`number`\>
+##### array
+
+`ArrayLike`\<`number`\>
 
 The bytes to encode.
 
-• **startIndex?**: `number`
+##### startIndex?
+
+`number`
 
 The index to start in the bytes.
 
-• **length?**: `number`
+##### length?
+
+`number`
 
 The length of bytes to read.
 
@@ -50,7 +56,9 @@ Convert a UTF8 string to raw array.
 
 #### Parameters
 
-• **utf8**: `string`
+##### utf8
+
+`string`
 
 The text to decode.
 
@@ -64,29 +72,39 @@ The array.
 
 ### bytesToHex()
 
-> `static` **bytesToHex**(`array`, `includePrefix`, `startIndex`?, `length`?, `reverse`?): `string`
+> `static` **bytesToHex**(`array`, `includePrefix`, `startIndex?`, `length?`, `reverse?`): `string`
 
 Encode a raw array to hex string.
 
 #### Parameters
 
-• **array**: `ArrayLike`\<`number`\>
+##### array
+
+`ArrayLike`\<`number`\>
 
 The bytes to encode.
 
-• **includePrefix**: `boolean` = `false`
+##### includePrefix
+
+`boolean` = `false`
 
 Include the 0x prefix on the returned hex.
 
-• **startIndex?**: `number`
+##### startIndex?
+
+`number`
 
 The index to start in the bytes.
 
-• **length?**: `number`
+##### length?
+
+`number`
 
 The length of bytes to read.
 
-• **reverse?**: `boolean`
+##### reverse?
+
+`boolean`
 
 Reverse the combine direction.
 
@@ -100,17 +118,21 @@ The array formatted as hex.
 
 ### hexToBytes()
 
-> `static` **hexToBytes**(`hex`, `reverse`?): `Uint8Array`
+> `static` **hexToBytes**(`hex`, `reverse?`): `Uint8Array`
 
 Decode a hex string to raw array.
 
 #### Parameters
 
-• **hex**: `string`
+##### hex
+
+`string`
 
 The hex to decode.
 
-• **reverse?**: `boolean`
+##### reverse?
+
+`boolean`
 
 Store the characters in reverse.
 
@@ -130,11 +152,15 @@ Convert the UTF8 to hex.
 
 #### Parameters
 
-• **utf8**: `string`
+##### utf8
+
+`string`
 
 The text to convert.
 
-• **includePrefix**: `boolean` = `false`
+##### includePrefix
+
+`boolean` = `false`
 
 Include the 0x prefix on the returned hex.
 
@@ -154,7 +180,9 @@ Convert the hex text to text.
 
 #### Parameters
 
-• **hex**: `string`
+##### hex
+
+`string`
 
 The hex to convert.
 
@@ -174,7 +202,9 @@ Convert bytes to binary string.
 
 #### Parameters
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The bytes to convert.
 
@@ -194,7 +224,9 @@ Convert a binary string to bytes.
 
 #### Parameters
 
-• **binary**: `string`
+##### binary
+
+`string`
 
 The binary string.
 
@@ -214,7 +246,9 @@ Convert bytes to base64 string.
 
 #### Parameters
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The bytes to convert.
 
@@ -234,7 +268,9 @@ Convert a base64 string to bytes.
 
 #### Parameters
 
-• **base64**: `string`
+##### base64
+
+`string`
 
 The base64 string.
 
@@ -254,7 +290,9 @@ Convert bytes to base64 url string.
 
 #### Parameters
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The bytes to convert.
 
@@ -274,7 +312,9 @@ Convert a base64 url string to bytes.
 
 #### Parameters
 
-• **base64Url**: `string`
+##### base64Url
+
+`string`
 
 The base64 url string.
 
@@ -283,3 +323,47 @@ The base64 url string.
 `Uint8Array`
 
 The bytes.
+
+***
+
+### bytesToBase58()
+
+> `static` **bytesToBase58**(`bytes`): `string`
+
+Convert bytes to base58 string.
+
+#### Parameters
+
+##### bytes
+
+`Uint8Array`
+
+The bytes to convert.
+
+#### Returns
+
+`string`
+
+A base58 string of the bytes.
+
+***
+
+### base58ToBytes()
+
+> `static` **base58ToBytes**(`base58`): `Uint8Array`
+
+Convert a base58 string to bytes.
+
+#### Parameters
+
+##### base58
+
+`string`
+
+The base58 string.
+
+#### Returns
+
+`Uint8Array`
+
+The bytes.

package/docs/reference/classes/EnvHelper.md

@@ -0,0 +1,45 @@
+# Class: EnvHelper
+
+Environment variable helper.
+
+## Constructors
+
+### Constructor
+
+> **new EnvHelper**(): `EnvHelper`
+
+#### Returns
+
+`EnvHelper`
+
+## Methods
+
+### envToJson()
+
+> `static` **envToJson**\<`T`\>(`envVars`, `prefix?`): `T`
+
+Get the environment variable as an object with camel cased names.
+
+#### Type Parameters
+
+##### T
+
+`T` = \{[`id`: `string`]: `string`; \}
+
+#### Parameters
+
+##### envVars
+
+The environment variables.
+
+##### prefix?
+
+`string`
+
+The prefix of the environment variables, if not provided gets all.
+
+#### Returns
+
+`T`
+
+The object with camel cased names.

package/docs/reference/classes/ErrorHelper.md

@@ -4,28 +4,36 @@ Error helper functions.
 
 ## Constructors
 
-### new ErrorHelper()
+### Constructor
 
-> **new ErrorHelper**(): [`ErrorHelper`](ErrorHelper.md)
+> **new ErrorHelper**(): `ErrorHelper`
 
 #### Returns
 
-[`ErrorHelper`](ErrorHelper.md)
+`ErrorHelper`
 
 ## Methods
 
 ### formatErrors()
 
-> `static` **formatErrors**(`error`): `string`[]
+> `static` **formatErrors**(`error`, `includeDetails?`): `string`[]
 
 Format Errors and returns just their messages.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to format.
 
+##### includeDetails?
+
+`boolean`
+
+Whether to include error details, defaults to false.
+
 #### Returns
 
 `string`[]
@@ -42,7 +50,9 @@ Localize the content of an error and any inner errors.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to format.
 
@@ -62,7 +72,9 @@ Localize the content of an error and any inner errors.
 
 #### Parameters
 
-• **error**: [`IError`](../interfaces/IError.md)
+##### error
+
+[`IError`](../interfaces/IError.md)
 
 The error to format.