@twin.org/core 0.0.1-next.6 → 0.0.1-next.60

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.
 

package/docs/reference/classes/GeneralError.md

@@ -8,37 +8,43 @@ Class to handle errors.
 
 ## Constructors
 
-### new GeneralError()
+### Constructor
 
-> **new GeneralError**(`source`, `message`, `properties`?, `inner`?): [`GeneralError`](GeneralError.md)
+> **new GeneralError**(`source`, `message`, `properties?`, `inner?`): `GeneralError`
 
 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.
 
 #### Returns
 
-[`GeneralError`](GeneralError.md)
+`GeneralError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -62,7 +68,7 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Inherited from
 
@@ -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`
@@ -360,10 +400,18 @@ True if the error has the name.
 
 ### toJsonObject()
 
-> **toJsonObject**(): [`IError`](../interfaces/IError.md)
+> **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 
 Serialize the error to the error model.
 
+#### Parameters
+
+##### includeStackTrace?
+
+`boolean`
+
+Whether to include the error stack in the model, defaults to false.
+
 #### Returns
 
 [`IError`](../interfaces/IError.md)