@twin.org/core 0.0.1-next.5 → 0.0.1-next.50

package/docs/reference/classes/Compression.md

@@ -16,23 +16,27 @@ A class to handle compression.
 
 ### compress()
 
-> `static` **compress**(`bytes`, `type`): `Promise`\<`Uint8Array`\>
+> `static` **compress**(`bytes`, `type`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
 Compress bytes using GZIP.
 
 #### Parameters
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The bytes to compress.
 
-• **type**: [`CompressionType`](../type-aliases/CompressionType.md)
+##### type
+
+[`CompressionType`](../type-aliases/CompressionType.md)
 
 The type of compression to use.
 
 #### Returns
 
-`Promise`\<`Uint8Array`\>
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
 The compressed bytes.
 
@@ -40,22 +44,26 @@ The compressed bytes.
 
 ### decompress()
 
-> `static` **decompress**(`compressedBytes`, `type`): `Promise`\<`Uint8Array`\>
+> `static` **decompress**(`compressedBytes`, `type`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
 Decompress a gzipped compressed byte array.
 
 #### Parameters
 
-• **compressedBytes**: `Uint8Array`
+##### compressedBytes
+
+`Uint8Array`
 
 The compressed bytes.
 
-• **type**: [`CompressionType`](../type-aliases/CompressionType.md)
+##### type
+
+[`CompressionType`](../type-aliases/CompressionType.md)
 
 The type of compression to use.
 
 #### Returns
 
-`Promise`\<`Uint8Array`\>
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
 The decompressed bytes.

package/docs/reference/classes/ConflictError.md

@@ -16,23 +16,33 @@ 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.
 
@@ -54,7 +64,7 @@ The source of the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source-1)
 
 ***
 
@@ -66,11 +76,11 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties)
+[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties-1)
 
 ***
 
@@ -82,7 +92,7 @@ The inner error if there was one.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
+[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner-1)
 
 ***
 
@@ -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`

package/docs/reference/classes/Converter.md

@@ -22,15 +22,21 @@ 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.
 
@@ -70,23 +78,33 @@ 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.
 
@@ -106,11 +124,15 @@ 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,43 @@
+# Class: EnvHelper
+
+Environment variable helper.
+
+## Constructors
+
+### new EnvHelper()
+
+> **new EnvHelper**(): [`EnvHelper`](EnvHelper.md)
+
+#### Returns
+
+[`EnvHelper`](EnvHelper.md)
+
+## Methods
+
+### envToJson()
+
+> `static` **envToJson**\<`T`\>(`envVars`, `prefix`?): `T`
+
+Get the environment variable as an object with camel cased names.
+
+#### Type Parameters
+
+• **T** = \{\}
+
+#### 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

@@ -22,7 +22,9 @@ Format Errors and returns just their messages.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to format.
 
@@ -42,7 +44,9 @@ Localize the content of an error and any inner errors.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to format.
 
@@ -62,7 +66,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.