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

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.
 
@@ -294,7 +334,9 @@ Convert bytes to base58 string.
 
 #### Parameters
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The bytes to convert.
 
@@ -314,7 +356,9 @@ Convert a base58 string to bytes.
 
 #### Parameters
 
-• **base58**: `string`
+##### base58
+
+`string`
 
 The base58 string.
 

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.
 

package/docs/reference/classes/Factory.md

@@ -4,42 +4,90 @@ Factory for creating implementation of generic types.
 
 ## Type Parameters
 
-• **T**
+### T
+
+`T`
 
 ## Methods
 
 ### createFactory()
 
-> `static` **createFactory**\<`U`\>(`typeName`, `autoInstance`, `matcher`?): [`Factory`](Factory.md)\<`U`\>
+> `static` **createFactory**\<`U`\>(`typeName`, `autoInstance`, `matcher?`): `Factory`\<`U`\>
 
 Create a new factory, which is shared throughout all library instances.
 
 #### Type Parameters
 
-• **U**
+##### U
+
+`U`
 
 #### 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.
 
 #### Returns
 
-[`Factory`](Factory.md)\<`U`\>
+`Factory`\<`U`\>
 
 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`
@@ -48,15 +96,21 @@ Register a new generator.
 
 #### Type Parameters
 
-• **U**
+##### U
+
+`U`
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The name of the generator.
 
-• **generator**
+##### generator
+
+() => `U`
 
 The function to create an instance.
 
@@ -74,7 +128,9 @@ Unregister a generator.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The name of the generator to unregister.
 
@@ -100,11 +156,15 @@ Get a generator instance.
 
 #### Type Parameters
 
-• **U**
+##### U
+
+`U`
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The name of the instance to generate.
 
@@ -132,11 +192,15 @@ Get a generator instance with no exceptions.
 
 #### Type Parameters
 
-• **U**
+##### U
+
+`U`
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The name of the instance to generate.
 
@@ -152,7 +216,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 +286,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

@@ -4,13 +4,13 @@ Class to help with filenames.
 
 ## Constructors
 
-### new FilenameHelper()
+### Constructor
 
-> **new FilenameHelper**(): [`FilenameHelper`](FilenameHelper.md)
+> **new FilenameHelper**(): `FilenameHelper`
 
 #### Returns
 
-[`FilenameHelper`](FilenameHelper.md)
+`FilenameHelper`
 
 ## Methods
 
@@ -22,7 +22,9 @@ Replaces any unsafe characters in the filename.
 
 #### Parameters
 
-• **filename**: `unknown`
+##### filename
+
+`unknown`
 
 The filename to make safe.