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

package/docs/reference/classes/Factory.md

@@ -8,11 +8,19 @@ Factory for creating implementation of generic types.
 
 `T`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+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.
 
@@ -30,7 +38,7 @@ Create a new factory, which is shared throughout all library instances.
 
 The type name for the instances.
 
-##### autoInstance
+##### autoInstance?
 
 `boolean` = `false`
 
@@ -38,7 +46,7 @@ Automatically create an instance when registered.
 
 ##### matcher?
 
-(`names`, `name`) => `undefined` \| `string`
+(`names`, `name`) => `string` \| `undefined`
 
 Match the name of the instance.
 
@@ -50,7 +58,7 @@ The factory instance.
 
 ***
 
-### getFactories()
+### getFactories() {#getfactories}
 
 > `static` **getFactories**(): `object`
 
@@ -64,7 +72,7 @@ All the factories.
 
 ***
 
-### resetFactories()
+### resetFactories() {#resetfactories}
 
 > `static` **resetFactories**(): `void`
 
@@ -76,7 +84,7 @@ Reset all the factories, which removes any created instances, but not the regist
 
 ***
 
-### clearFactories()
+### clearFactories() {#clearfactories}
 
 > `static` **clearFactories**(): `void`
 
@@ -88,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`
 
@@ -110,7 +132,7 @@ The name of the generator.
 
 ##### generator
 
-() => `U`
+(`args?`) => `U`
 
 The function to create an instance.
 
@@ -120,7 +142,7 @@ The function to create an instance.
 
 ***
 
-### unregister()
+### unregister() {#unregister}
 
 > **unregister**(`name`): `void`
 
@@ -148,7 +170,7 @@ GeneralError if no generator exists.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**\<`U`\>(`name`): `U`
 
@@ -184,9 +206,9 @@ GeneralError if no item exists to get.
 
 ***
 
-### getIfExists()
+### getIfExists() {#getifexists}
 
-> **getIfExists**\<`U`\>(`name?`): `undefined` \| `U`
+> **getIfExists**\<`U`\>(`name?`): `U` \| `undefined`
 
 Get a generator instance with no exceptions.
 
@@ -206,13 +228,93 @@ The name of the instance to generate.
 
 #### Returns
 
-`undefined` \| `U`
+`U` \| `undefined`
 
 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`
 
@@ -224,7 +326,7 @@ Remove all the instances and leave the generators intact.
 
 ***
 
-### clear()
+### clear() {#clear}
 
 > **clear**(): `void`
 
@@ -236,7 +338,7 @@ Remove all the instances and the generators.
 
 ***
 
-### instancesMap()
+### instancesMap() {#instancesmap}
 
 > **instancesMap**(): `object`
 
@@ -250,7 +352,7 @@ The instances as a map.
 
 ***
 
-### instancesList()
+### instancesList() {#instanceslist}
 
 > **instancesList**(): `T`[]
 
@@ -264,7 +366,7 @@ The instances as a list in the order they were registered.
 
 ***
 
-### names()
+### names() {#names}
 
 > **names**(): `string`[]
 
@@ -278,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`
 

package/docs/reference/classes/GeneralError.md

@@ -26,7 +26,7 @@ The source of the error.
 
 `string`
 
-The message as a code.
+The message as an i18n key.
 
 ##### properties?
 
@@ -48,9 +48,9 @@ The cause of the error if we have wrapped another error.
 
 ## Properties
 
-### source?
+### source? {#source}
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
 The source of the error.
 
@@ -60,9 +60,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -76,9 +76,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.
 
@@ -88,7 +88,7 @@ The cause of the error.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -96,7 +96,7 @@ Runtime name for the class.
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
 
@@ -122,7 +122,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -148,9 +148,9 @@ The list of all internal errors.
 
 ***
 
-### expand()
+### expand() {#expand}
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -158,13 +158,13 @@ Expand an error tree.
 
 ##### errors
 
-The list of errors to expand.
+[`IError`](../interfaces/IError.md)[] \| `undefined`
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+The list of errors to expand.
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 
@@ -174,7 +174,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -190,9 +190,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -206,7 +206,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -222,9 +222,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -238,7 +238,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -254,9 +254,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -270,7 +270,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -286,9 +286,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -302,7 +302,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -318,9 +318,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -334,7 +334,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -366,7 +366,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -382,9 +382,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -398,7 +398,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -424,7 +424,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -450,7 +450,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -482,7 +482,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)