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

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.
 

package/docs/reference/classes/Factory.md

@@ -20,15 +20,21 @@ Create a new factory, which is shared throughout all library instances.
 
 #### Parameters
 
-• **typeName**: `string`
+##### typeName
+
+`string`
 
 The type name for the instances.
 
-• **autoInstance**: `boolean` = `false`
+##### autoInstance
+
+`boolean` = `false`
 
 Automatically create an instance when registered.
 
-• **matcher?**
+##### matcher?
+
+(`names`, `name`) => `undefined` \| `string`
 
 Match the name of the instance.
 
@@ -40,6 +46,44 @@ The factory instance.
 
 ***
 
+### getFactories()
+
+> `static` **getFactories**(): `object`
+
+Get all the factories.
+
+#### Returns
+
+`object`
+
+All the factories.
+
+***
+
+### resetFactories()
+
+> `static` **resetFactories**(): `void`
+
+Reset all the factories, which removes any created instances, but not the registrations.
+
+#### Returns
+
+`void`
+
+***
+
+### clearFactories()
+
+> `static` **clearFactories**(): `void`
+
+Clear all the factories, which removes anything registered with the factories.
+
+#### Returns
+
+`void`
+
+***
+
 ### register()
 
 > **register**\<`U`\>(`name`, `generator`): `void`
@@ -52,11 +96,15 @@ Register a new generator.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The name of the generator.
 
-• **generator**
+##### generator
+
+() => `U`
 
 The function to create an instance.
 
@@ -74,7 +122,9 @@ Unregister a generator.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The name of the generator to unregister.
 
@@ -104,7 +154,9 @@ Get a generator instance.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The name of the instance to generate.
 
@@ -136,7 +188,9 @@ Get a generator instance with no exceptions.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The name of the instance to generate.
 
@@ -152,7 +206,19 @@ An instance of the item or undefined if it does not exist.
 
 > **reset**(): `void`
 
-Reset all the instances.
+Remove all the instances and leave the generators intact.
+
+#### Returns
+
+`void`
+
+***
+
+### clear()
+
+> **clear**(): `void`
+
+Remove all the instances and the generators.
 
 #### Returns
 
@@ -210,7 +276,9 @@ Does the factory contain the name.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The name of the instance to find.
 

package/docs/reference/classes/FilenameHelper.md

@@ -22,7 +22,9 @@ Replaces any unsafe characters in the filename.
 
 #### Parameters
 
-• **filename**: `unknown`
+##### filename
+
+`unknown`
 
 The filename to make safe.
 

package/docs/reference/classes/GeneralError.md

@@ -16,19 +16,25 @@ Create a new instance of GeneralError.
 
 #### 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.
 
@@ -50,7 +56,7 @@ The source of the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source-1)
 
 ***
 
@@ -62,11 +68,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)
 
 ***
 
@@ -78,7 +84,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)
 
 ***
 
@@ -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`