@twin.org/core 0.0.1-next.1

package/docs/reference/classes/Factory.md

@@ -0,0 +1,221 @@
+# Class: Factory\<T\>
+
+Factory for creating implementation of generic types.
+
+## Type Parameters
+
+• **T**
+
+## Methods
+
+### createFactory()
+
+> `static` **createFactory**\<`U`\>(`typeName`, `autoInstance`, `matcher`?): [`Factory`](Factory.md)\<`U`\>
+
+Create a new factory, which is shared throughout all library instances.
+
+#### Type Parameters
+
+• **U**
+
+#### Parameters
+
+• **typeName**: `string`
+
+The type name for the instances.
+
+• **autoInstance**: `boolean` = `false`
+
+Automatically create an instance when registered.
+
+• **matcher?**
+
+Match the name of the instance.
+
+#### Returns
+
+[`Factory`](Factory.md)\<`U`\>
+
+The factory instance.
+
+***
+
+### register()
+
+> **register**\<`U`\>(`name`, `generator`): `void`
+
+Register a new generator.
+
+#### Type Parameters
+
+• **U**
+
+#### Parameters
+
+• **name**: `string`
+
+The name of the generator.
+
+• **generator**
+
+The function to create an instance.
+
+#### Returns
+
+`void`
+
+***
+
+### unregister()
+
+> **unregister**(`name`): `void`
+
+Unregister a generator.
+
+#### Parameters
+
+• **name**: `string`
+
+The name of the generator to unregister.
+
+#### Returns
+
+`void`
+
+#### Throws
+
+GuardError if the parameters are invalid.
+
+#### Throws
+
+GeneralError if no generator exists.
+
+***
+
+### get()
+
+> **get**\<`U`\>(`name`): `U`
+
+Get a generator instance.
+
+#### Type Parameters
+
+• **U**
+
+#### Parameters
+
+• **name**: `string`
+
+The name of the instance to generate.
+
+#### Returns
+
+`U`
+
+An instance of the item.
+
+#### Throws
+
+GuardError if the parameters are invalid.
+
+#### Throws
+
+GeneralError if no item exists to get.
+
+***
+
+### getIfExists()
+
+> **getIfExists**\<`U`\>(`name`): `undefined` \| `U`
+
+Get a generator instance with no exceptions.
+
+#### Type Parameters
+
+• **U**
+
+#### Parameters
+
+• **name**: `string`
+
+The name of the instance to generate.
+
+#### Returns
+
+`undefined` \| `U`
+
+An instance of the item or undefined if it does not exist.
+
+***
+
+### reset()
+
+> **reset**(): `void`
+
+Reset all the instances.
+
+#### Returns
+
+`void`
+
+***
+
+### instancesMap()
+
+> **instancesMap**(): `object`
+
+Get all the instances as a map.
+
+#### Returns
+
+`object`
+
+The instances as a map.
+
+***
+
+### instancesList()
+
+> **instancesList**(): `T`[]
+
+Get all the instances as a list in the order they were registered.
+
+#### Returns
+
+`T`[]
+
+The instances as a list in the order they were registered.
+
+***
+
+### names()
+
+> **names**(): `string`[]
+
+Get all the generator names in the order they were registered.
+
+#### Returns
+
+`string`[]
+
+The ordered generator names.
+
+***
+
+### hasName()
+
+> **hasName**(`name`): `boolean`
+
+Does the factory contain the name.
+
+#### Parameters
+
+• **name**: `string`
+
+The name of the instance to find.
+
+#### Returns
+
+`boolean`
+
+True if the factory has a matching name.

package/docs/reference/classes/FilenameHelper.md

@@ -0,0 +1,33 @@
+# Class: FilenameHelper
+
+Class to help with filenames.
+
+## Constructors
+
+### new FilenameHelper()
+
+> **new FilenameHelper**(): [`FilenameHelper`](FilenameHelper.md)
+
+#### Returns
+
+[`FilenameHelper`](FilenameHelper.md)
+
+## Methods
+
+### safeFilename()
+
+> `static` **safeFilename**(`filename`): `string`
+
+Replaces any unsafe characters in the filename.
+
+#### Parameters
+
+• **filename**: `unknown`
+
+The filename to make safe.
+
+#### Returns
+
+`string`
+
+The safe filename.

package/docs/reference/classes/GeneralError.md

@@ -0,0 +1,375 @@
+# Class: GeneralError
+
+Class to handle errors.
+
+## Extends
+
+- [`BaseError`](BaseError.md)
+
+## Constructors
+
+### new GeneralError()
+
+> **new GeneralError**(`source`, `message`, `properties`?, `inner`?): [`GeneralError`](GeneralError.md)
+
+Create a new instance of GeneralError.
+
+#### Parameters
+
+• **source**: `string`
+
+The source of the error.
+
+• **message**: `string`
+
+The message as a code.
+
+• **properties?**
+
+Any additional information for the error.
+
+• **inner?**: `unknown`
+
+The inner error if we have wrapped another error.
+
+#### Returns
+
+[`GeneralError`](GeneralError.md)
+
+#### Overrides
+
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+
+## Properties
+
+### source?
+
+> `optional` **source**: `string`
+
+The source of the error.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
+
+***
+
+### properties?
+
+> `optional` **properties**: `object`
+
+Any additional information for the error.
+
+#### Index Signature
+
+ \[`id`: `string`\]: `unknown`
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties)
+
+***
+
+### inner?
+
+> `optional` **inner**: [`IError`](../interfaces/IError.md)
+
+The inner error if there was one.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
+
+***
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### fromError()
+
+> `static` **fromError**(`err`): [`BaseError`](BaseError.md)
+
+Construct an error from an existing one.
+
+#### Parameters
+
+• **err**: `unknown`
+
+The existing error.
+
+#### Returns
+
+[`BaseError`](BaseError.md)
+
+The new instance.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`fromError`](BaseError.md#fromerror)
+
+***
+
+### flatten()
+
+> `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
+
+Flatten an error tree.
+
+#### Parameters
+
+• **err**: `unknown`
+
+The starting error.
+
+#### Returns
+
+[`IError`](../interfaces/IError.md)[]
+
+The list of all internal errors.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`flatten`](BaseError.md#flatten)
+
+***
+
+### expand()
+
+> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+
+Expand an error tree.
+
+#### Parameters
+
+• **errors**: `undefined` \| [`IError`](../interfaces/IError.md)[]
+
+The list of errors to expand.
+
+#### Returns
+
+`undefined` \| [`IError`](../interfaces/IError.md)
+
+The first level error.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`expand`](BaseError.md#expand)
+
+***
+
+### isErrorName()
+
+> `static` **isErrorName**(`error`, `name`): `error is BaseError`
+
+Test to see if the error has the specified error name.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **name**: `string` \| `RegExp`
+
+The name to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isErrorName`](BaseError.md#iserrorname)
+
+***
+
+### isErrorMessage()
+
+> `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
+
+Test to see if the error has the specified error message.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **message**: `string` \| `RegExp`
+
+The message to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isErrorMessage`](BaseError.md#iserrormessage)
+
+***
+
+### isErrorCode()
+
+> `static` **isErrorCode**(`error`, `code`): `boolean`
+
+Test to see if the error has the specified error code.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **code**: `string` \| `RegExp`
+
+The code to check for.
+
+#### Returns
+
+`boolean`
+
+True if the error has the code.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isErrorCode`](BaseError.md#iserrorcode)
+
+***
+
+### someErrorName()
+
+> `static` **someErrorName**(`error`, `name`): `error is BaseError`
+
+Test to see if any of the errors or children have the given error name.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **name**: `string` \| `RegExp`
+
+The name to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`someErrorName`](BaseError.md#someerrorname)
+
+***
+
+### someErrorMessage()
+
+> `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
+
+Test to see if any of the errors or children have the given error message.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **message**: `string` \| `RegExp`
+
+The message to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`someErrorMessage`](BaseError.md#someerrormessage)
+
+***
+
+### someErrorClass()
+
+> `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
+
+Test to see if any of the errors or children are from a specific class.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **cls**: `string`
+
+The class to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the specific class.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`someErrorClass`](BaseError.md#someerrorclass)
+
+***
+
+### someErrorCode()
+
+> `static` **someErrorCode**(`error`, `code`): `error is BaseError`
+
+Test to see if any of the errors or children have the given error code.
+
+#### Parameters
+
+• **error**: `unknown`
+
+The error to test.
+
+• **code**: `string` \| `RegExp`
+
+The code to check for.
+
+#### Returns
+
+`error is BaseError`
+
+True if the error has the name.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`someErrorCode`](BaseError.md#someerrorcode)
+
+***
+
+### toJsonObject()
+
+> **toJsonObject**(): [`IError`](../interfaces/IError.md)
+
+Serialize the error to the error model.
+
+#### Returns
+
+[`IError`](../interfaces/IError.md)
+
+The error model.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`toJsonObject`](BaseError.md#tojsonobject)