@twin.org/core 0.0.3-next.3 → 0.0.3-next.31

package/docs/reference/classes/ConflictError.md

@@ -60,9 +60,9 @@ The cause or the error if we have wrapped another error.
 
 ## Properties
 
-### source?
+### source? {#source}
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
 The source of the error.
 
@@ -72,9 +72,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -88,9 +88,9 @@ Any additional information for the error.
 
 ***
 
-### cause?
+### cause? {#cause}
 
-> `optional` **cause**: [`IError`](../interfaces/IError.md)
+> `optional` **cause?**: [`IError`](../interfaces/IError.md)
 
 The cause of the error.
 
@@ -100,7 +100,7 @@ The cause of the error.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -108,7 +108,7 @@ Runtime name for the class.
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
 
@@ -134,7 +134,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -160,7 +160,7 @@ The list of all internal errors.
 
 ***
 
-### expand()
+### expand() {#expand}
 
 > `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
@@ -170,9 +170,9 @@ Expand an error tree.
 
 ##### errors
 
-The list of errors to expand.
+[`IError`](../interfaces/IError.md)[] \| `undefined`
 
-[`IError`](../interfaces/IError.md)[] | `undefined`
+The list of errors to expand.
 
 #### Returns
 
@@ -186,7 +186,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -202,9 +202,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -218,7 +218,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -234,9 +234,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -250,7 +250,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -266,9 +266,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -282,7 +282,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -298,9 +298,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -314,7 +314,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -330,9 +330,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -346,7 +346,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -378,7 +378,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -394,9 +394,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -410,7 +410,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -436,7 +436,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -462,7 +462,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -494,7 +494,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 

package/docs/reference/classes/Converter.md

@@ -14,7 +14,7 @@ Convert arrays to and from different formats.
 
 ## Methods
 
-### bytesToUtf8()
+### bytesToUtf8() {#bytestoutf8}
 
 > `static` **bytesToUtf8**(`array`, `startIndex?`, `length?`): `string`
 
@@ -48,7 +48,7 @@ The array formatted as UTF8.
 
 ***
 
-### utf8ToBytes()
+### utf8ToBytes() {#utf8tobytes}
 
 > `static` **utf8ToBytes**(`utf8`): `Uint8Array`
 
@@ -70,9 +70,9 @@ The array.
 
 ***
 
-### bytesToHex()
+### bytesToHex() {#bytestohex}
 
-> `static` **bytesToHex**(`array`, `includePrefix`, `startIndex?`, `length?`, `reverse?`): `string`
+> `static` **bytesToHex**(`array`, `includePrefix?`, `startIndex?`, `length?`, `reverse?`): `string`
 
 Encode a raw array to hex string.
 
@@ -84,7 +84,7 @@ Encode a raw array to hex string.
 
 The bytes to encode.
 
-##### includePrefix
+##### includePrefix?
 
 `boolean` = `false`
 
@@ -116,7 +116,7 @@ The array formatted as hex.
 
 ***
 
-### hexToBytes()
+### hexToBytes() {#hextobytes}
 
 > `static` **hexToBytes**(`hex`, `reverse?`): `Uint8Array`
 
@@ -144,9 +144,9 @@ The array.
 
 ***
 
-### utf8ToHex()
+### utf8ToHex() {#utf8tohex}
 
-> `static` **utf8ToHex**(`utf8`, `includePrefix`): `string`
+> `static` **utf8ToHex**(`utf8`, `includePrefix?`): `string`
 
 Convert the UTF8 to hex.
 
@@ -158,7 +158,7 @@ Convert the UTF8 to hex.
 
 The text to convert.
 
-##### includePrefix
+##### includePrefix?
 
 `boolean` = `false`
 
@@ -172,7 +172,7 @@ The hex version of the bytes.
 
 ***
 
-### hexToUtf8()
+### hexToUtf8() {#hextoutf8}
 
 > `static` **hexToUtf8**(`hex`): `string`
 
@@ -194,7 +194,7 @@ The UTF8 version of the bytes.
 
 ***
 
-### bytesToBinary()
+### bytesToBinary() {#bytestobinary}
 
 > `static` **bytesToBinary**(`bytes`): `string`
 
@@ -216,7 +216,7 @@ A binary string of the bytes.
 
 ***
 
-### binaryToBytes()
+### binaryToBytes() {#binarytobytes}
 
 > `static` **binaryToBytes**(`binary`): `Uint8Array`
 
@@ -238,7 +238,7 @@ The bytes.
 
 ***
 
-### bytesToBase64()
+### bytesToBase64() {#bytestobase64}
 
 > `static` **bytesToBase64**(`bytes`): `string`
 
@@ -260,7 +260,7 @@ A base64 string of the bytes.
 
 ***
 
-### base64ToBytes()
+### base64ToBytes() {#base64tobytes}
 
 > `static` **base64ToBytes**(`base64`): `Uint8Array`
 
@@ -282,7 +282,7 @@ The bytes.
 
 ***
 
-### bytesToBase64Url()
+### bytesToBase64Url() {#bytestobase64url}
 
 > `static` **bytesToBase64Url**(`bytes`): `string`
 
@@ -304,7 +304,7 @@ A base64 url string of the bytes.
 
 ***
 
-### base64UrlToBytes()
+### base64UrlToBytes() {#base64urltobytes}
 
 > `static` **base64UrlToBytes**(`base64Url`): `Uint8Array`
 
@@ -326,7 +326,7 @@ The bytes.
 
 ***
 
-### bytesToBase58()
+### bytesToBase58() {#bytestobase58}
 
 > `static` **bytesToBase58**(`bytes`): `string`
 
@@ -348,7 +348,7 @@ A base58 string of the bytes.
 
 ***
 
-### base58ToBytes()
+### base58ToBytes() {#base58tobytes}
 
 > `static` **base58ToBytes**(`base58`): `Uint8Array`
 

package/docs/reference/classes/EnvHelper.md

@@ -14,7 +14,7 @@ Environment variable helper.
 
 ## Methods
 
-### envToJson()
+### envToJson() {#envtojson}
 
 > `static` **envToJson**\<`T`\>(`envVars`, `prefix?`): `T`
 

package/docs/reference/classes/ErrorHelper.md

@@ -14,7 +14,7 @@ Error helper functions.
 
 ## Methods
 
-### formatErrors()
+### formatErrors() {#formaterrors}
 
 > `static` **formatErrors**(`error`, `includeDetails?`): `string`[]
 
@@ -42,7 +42,7 @@ The error formatted including any causes errors.
 
 ***
 
-### localizeErrors()
+### localizeErrors() {#localizeerrors}
 
 > `static` **localizeErrors**(`error`): [`IError`](../interfaces/IError.md)[]
 
@@ -64,7 +64,7 @@ The localized version of the errors flattened.
 
 ***
 
-### formatValidationErrors()
+### formatValidationErrors() {#formatvalidationerrors}
 
 > `static` **formatValidationErrors**(`error`): `string` \| `undefined`
 

package/docs/reference/classes/Factory.md

@@ -10,7 +10,7 @@ Factory for creating implementation of generic types.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -18,9 +18,9 @@ Runtime name for the class.
 
 ## Methods
 
-### createFactory()
+### createFactory() {#createfactory}
 
-> `static` **createFactory**\<`U`\>(`typeName`, `autoInstance`, `matcher?`): `Factory`\<`U`\>
+> `static` **createFactory**\<`U`\>(`typeName`, `autoInstance?`, `matcher?`): `Factory`\<`U`\>
 
 Create a new factory, which is shared throughout all library instances.
 
@@ -38,7 +38,7 @@ Create a new factory, which is shared throughout all library instances.
 
 The type name for the instances.
 
-##### autoInstance
+##### autoInstance?
 
 `boolean` = `false`
 
@@ -58,7 +58,7 @@ The factory instance.
 
 ***
 
-### getFactories()
+### getFactories() {#getfactories}
 
 > `static` **getFactories**(): `object`
 
@@ -72,7 +72,7 @@ All the factories.
 
 ***
 
-### resetFactories()
+### resetFactories() {#resetfactories}
 
 > `static` **resetFactories**(): `void`
 
@@ -84,7 +84,7 @@ Reset all the factories, which removes any created instances, but not the regist
 
 ***
 
-### clearFactories()
+### clearFactories() {#clearfactories}
 
 > `static` **clearFactories**(): `void`
 
@@ -96,7 +96,21 @@ Clear all the factories, which removes anything registered with the factories.
 
 ***
 
-### register()
+### typeName() {#typename}
+
+> **typeName**(): `string`
+
+Get the type name of the factory.
+
+#### Returns
+
+`string`
+
+The type name of the factory.
+
+***
+
+### register() {#register}
 
 > **register**\<`U`\>(`name`, `generator`): `void`
 
@@ -118,7 +132,7 @@ The name of the generator.
 
 ##### generator
 
-() => `U`
+(`args?`) => `U`
 
 The function to create an instance.
 
@@ -128,7 +142,7 @@ The function to create an instance.
 
 ***
 
-### unregister()
+### unregister() {#unregister}
 
 > **unregister**(`name`): `void`
 
@@ -156,7 +170,7 @@ GeneralError if no generator exists.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**\<`U`\>(`name`): `U`
 
@@ -192,7 +206,7 @@ GeneralError if no item exists to get.
 
 ***
 
-### getIfExists()
+### getIfExists() {#getifexists}
 
 > **getIfExists**\<`U`\>(`name?`): `U` \| `undefined`
 
@@ -220,7 +234,87 @@ An instance of the item or undefined if it does not exist.
 
 ***
 
-### reset()
+### create() {#create}
+
+> **create**\<`U`\>(`name`, `args?`): `U`
+
+Create a new instance without caching it.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### name
+
+`string`
+
+The name of the instance to generate.
+
+##### args?
+
+`unknown`
+
+The arguments to pass to the generator.
+
+#### Returns
+
+`U`
+
+A new instance of the item.
+
+#### Throws
+
+GuardError if the parameters are invalid.
+
+#### Throws
+
+GeneralError if no item exists to create.
+
+***
+
+### createIfExists() {#createifexists}
+
+> **createIfExists**\<`U`\>(`name`, `args?`): `U` \| `undefined`
+
+Create a new instance without caching it if it exists.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### name
+
+`string`
+
+The name of the instance to generate.
+
+##### args?
+
+`unknown`
+
+The arguments to pass to the generator.
+
+#### Returns
+
+`U` \| `undefined`
+
+A new instance of the item if it exists.
+
+#### Throws
+
+GuardError if the parameters are invalid.
+
+***
+
+### reset() {#reset}
 
 > **reset**(): `void`
 
@@ -232,7 +326,7 @@ Remove all the instances and leave the generators intact.
 
 ***
 
-### clear()
+### clear() {#clear}
 
 > **clear**(): `void`
 
@@ -244,7 +338,7 @@ Remove all the instances and the generators.
 
 ***
 
-### instancesMap()
+### instancesMap() {#instancesmap}
 
 > **instancesMap**(): `object`
 
@@ -258,7 +352,7 @@ The instances as a map.
 
 ***
 
-### instancesList()
+### instancesList() {#instanceslist}
 
 > **instancesList**(): `T`[]
 
@@ -272,7 +366,7 @@ The instances as a list in the order they were registered.
 
 ***
 
-### names()
+### names() {#names}
 
 > **names**(): `string`[]
 
@@ -286,7 +380,7 @@ The ordered generator names.
 
 ***
 
-### hasName()
+### hasName() {#hasname}
 
 > **hasName**(`name`): `boolean`
 

package/docs/reference/classes/FilenameHelper.md

@@ -14,7 +14,7 @@ Class to help with filenames.
 
 ## Methods
 
-### safeFilename()
+### safeFilename() {#safefilename}
 
 > `static` **safeFilename**(`filename`): `string`