@twin.org/core 0.0.1 → 0.0.2-next.11

package/docs/reference/classes/BaseError.md

@@ -27,7 +27,7 @@ Class to handle errors.
 
 ### Constructor
 
-> **new BaseError**(`name`, `source`, `message`, `properties?`, `inner?`): `BaseError`
+> **new BaseError**(`name`, `source`, `message`, `properties?`, `cause?`): `BaseError`
 
 Create a new instance of BaseError.
 
@@ -55,11 +55,11 @@ The message as a code.
 
 Any additional information for the error.
 
-##### inner?
+##### cause?
 
 `unknown`
 
-The inner error if we have wrapped another error.
+The cause of error if we have wrapped another error.
 
 #### Returns
 
@@ -99,15 +99,19 @@ Any additional information for the error.
 
 ***
 
-### inner?
+### cause?
 
-> `optional` **inner**: [`IError`](../interfaces/IError.md)
+> `optional` **cause**: [`IError`](../interfaces/IError.md)
 
-The inner error if there was one.
+The cause of the error.
 
 #### Implementation of
 
-[`IError`](../interfaces/IError.md).[`inner`](../interfaces/IError.md#inner)
+[`IError`](../interfaces/IError.md).[`cause`](../interfaces/IError.md#cause)
+
+#### Overrides
+
+`Error.cause`
 
 ## Methods
 
@@ -373,6 +377,78 @@ True if the error has the name.
 
 ***
 
+### isEmpty()
+
+> `static` **isEmpty**(`err`): `boolean`
+
+Is the error empty, i.e. does it have no message, source, properties, or cause?
+
+#### Parameters
+
+##### err
+
+[`IError`](../interfaces/IError.md)
+
+The error to check for being empty.
+
+#### Returns
+
+`boolean`
+
+True if the error is empty.
+
+***
+
+### isAggregateError()
+
+> `static` **isAggregateError**(`err`): `err is AggregateError`
+
+Is the error an aggregate error.
+
+#### Parameters
+
+##### err
+
+`unknown`
+
+The error to check for being an aggregate error.
+
+#### Returns
+
+`err is AggregateError`
+
+True if the error is an aggregate error.
+
+***
+
+### fromAggregate()
+
+> `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
+
+Convert the aggregate error to an array of errors.
+
+#### Parameters
+
+##### err
+
+`unknown`
+
+The error to convert.
+
+##### includeStackTrace?
+
+`boolean`
+
+Whether to include the error stack in the model, defaults to false.
+
+#### Returns
+
+[`IError`](../interfaces/IError.md)[]
+
+The array of errors.
+
+***
+
 ### toJsonObject()
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)

package/docs/reference/classes/ConflictError.md

@@ -10,7 +10,7 @@ Class to handle errors which are triggered by conflicting data.
 
 ### Constructor
 
-> **new ConflictError**(`source`, `message`, `conflictId?`, `conflicts?`, `inner?`): `ConflictError`
+> **new ConflictError**(`source`, `message`, `conflictId?`, `conflicts?`, `cause?`): `ConflictError`
 
 Create a new instance of ConflictError.
 
@@ -40,11 +40,11 @@ The id that has conflicts.
 
 The conflicts that occurred.
 
-##### inner?
+##### cause?
 
 `unknown`
 
-The inner error if we have wrapped another error.
+The cause or the error if we have wrapped another error.
 
 #### Returns
 
@@ -84,15 +84,15 @@ Any additional information for the error.
 
 ***
 
-### inner?
+### cause?
 
-> `optional` **inner**: [`IError`](../interfaces/IError.md)
+> `optional` **cause**: [`IError`](../interfaces/IError.md)
 
-The inner error if there was one.
+The cause of the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
+[`BaseError`](BaseError.md).[`cause`](BaseError.md#cause)
 
 ***
 
@@ -406,6 +406,90 @@ True if the error has the name.
 
 ***
 
+### isEmpty()
+
+> `static` **isEmpty**(`err`): `boolean`
+
+Is the error empty, i.e. does it have no message, source, properties, or cause?
+
+#### Parameters
+
+##### err
+
+[`IError`](../interfaces/IError.md)
+
+The error to check for being empty.
+
+#### Returns
+
+`boolean`
+
+True if the error is empty.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isEmpty`](BaseError.md#isempty)
+
+***
+
+### isAggregateError()
+
+> `static` **isAggregateError**(`err`): `err is AggregateError`
+
+Is the error an aggregate error.
+
+#### Parameters
+
+##### err
+
+`unknown`
+
+The error to check for being an aggregate error.
+
+#### Returns
+
+`err is AggregateError`
+
+True if the error is an aggregate error.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isAggregateError`](BaseError.md#isaggregateerror)
+
+***
+
+### fromAggregate()
+
+> `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
+
+Convert the aggregate error to an array of errors.
+
+#### Parameters
+
+##### err
+
+`unknown`
+
+The error to convert.
+
+##### includeStackTrace?
+
+`boolean`
+
+Whether to include the error stack in the model, defaults to false.
+
+#### Returns
+
+[`IError`](../interfaces/IError.md)[]
+
+The array of errors.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`fromAggregate`](BaseError.md#fromaggregate)
+
+***
+
 ### toJsonObject()
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)

package/docs/reference/classes/EnvHelper.md

@@ -24,7 +24,7 @@ Get the environment variable as an object with camel cased names.
 
 ##### T
 
-`T` = \{[`id`: `string`]: `string`; \}
+`T` = \{\[`id`: `string`\]: `string`; \}
 
 #### Parameters
 

package/docs/reference/classes/ErrorHelper.md

@@ -38,7 +38,7 @@ Whether to include error details, defaults to false.
 
 `string`[]
 
-The error formatted including any inner errors.
+The error formatted including any causes errors.
 
 ***
 
@@ -46,7 +46,7 @@ The error formatted including any inner errors.
 
 > `static` **localizeErrors**(`error`): [`IError`](../interfaces/IError.md)[]
 
-Localize the content of an error and any inner errors.
+Localize the content of an error and any causes.
 
 #### Parameters
 
@@ -68,7 +68,7 @@ The localized version of the errors flattened.
 
 > `static` **formatValidationErrors**(`error`): `undefined` \| `string`
 
-Localize the content of an error and any inner errors.
+Localize the content of an error and any causes.
 
 #### Parameters
 

package/docs/reference/classes/Factory.md

@@ -186,7 +186,7 @@ GeneralError if no item exists to get.
 
 ### getIfExists()
 
-> **getIfExists**\<`U`\>(`name`): `undefined` \| `U`
+> **getIfExists**\<`U`\>(`name?`): `undefined` \| `U`
 
 Get a generator instance with no exceptions.
 
@@ -198,7 +198,7 @@ Get a generator instance with no exceptions.
 
 #### Parameters
 
-##### name
+##### name?
 
 `string`
 

package/docs/reference/classes/GeneralError.md

@@ -10,7 +10,7 @@ Class to handle errors.
 
 ### Constructor
 
-> **new GeneralError**(`source`, `message`, `properties?`, `inner?`): `GeneralError`
+> **new GeneralError**(`source`, `message`, `properties?`, `cause?`): `GeneralError`
 
 Create a new instance of GeneralError.
 
@@ -32,11 +32,11 @@ The message as a code.
 
 Any additional information for the error.
 
-##### inner?
+##### cause?
 
 `unknown`
 
-The inner error if we have wrapped another error.
+The cause of the error if we have wrapped another error.
 
 #### Returns
 
@@ -76,15 +76,15 @@ Any additional information for the error.
 
 ***
 
-### inner?
+### cause?
 
-> `optional` **inner**: [`IError`](../interfaces/IError.md)
+> `optional` **cause**: [`IError`](../interfaces/IError.md)
 
-The inner error if there was one.
+The cause of the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
+[`BaseError`](BaseError.md).[`cause`](BaseError.md#cause)
 
 ***
 
@@ -398,6 +398,90 @@ True if the error has the name.
 
 ***
 
+### isEmpty()
+
+> `static` **isEmpty**(`err`): `boolean`
+
+Is the error empty, i.e. does it have no message, source, properties, or cause?
+
+#### Parameters
+
+##### err
+
+[`IError`](../interfaces/IError.md)
+
+The error to check for being empty.
+
+#### Returns
+
+`boolean`
+
+True if the error is empty.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isEmpty`](BaseError.md#isempty)
+
+***
+
+### isAggregateError()
+
+> `static` **isAggregateError**(`err`): `err is AggregateError`
+
+Is the error an aggregate error.
+
+#### Parameters
+
+##### err
+
+`unknown`
+
+The error to check for being an aggregate error.
+
+#### Returns
+
+`err is AggregateError`
+
+True if the error is an aggregate error.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isAggregateError`](BaseError.md#isaggregateerror)
+
+***
+
+### fromAggregate()
+
+> `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
+
+Convert the aggregate error to an array of errors.
+
+#### Parameters
+
+##### err
+
+`unknown`
+
+The error to convert.
+
+##### includeStackTrace?
+
+`boolean`
+
+Whether to include the error stack in the model, defaults to false.
+
+#### Returns
+
+[`IError`](../interfaces/IError.md)[]
+
+The array of errors.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`fromAggregate`](BaseError.md#fromaggregate)
+
+***
+
 ### toJsonObject()
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)

package/docs/reference/classes/GuardError.md

@@ -84,15 +84,15 @@ Any additional information for the error.
 
 ***
 
-### inner?
+### cause?
 
-> `optional` **inner**: [`IError`](../interfaces/IError.md)
+> `optional` **cause**: [`IError`](../interfaces/IError.md)
 
-The inner error if there was one.
+The cause of the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
+[`BaseError`](BaseError.md).[`cause`](BaseError.md#cause)
 
 ***
 
@@ -406,6 +406,90 @@ True if the error has the name.
 
 ***
 
+### isEmpty()
+
+> `static` **isEmpty**(`err`): `boolean`
+
+Is the error empty, i.e. does it have no message, source, properties, or cause?
+
+#### Parameters
+
+##### err
+
+[`IError`](../interfaces/IError.md)
+
+The error to check for being empty.
+
+#### Returns
+
+`boolean`
+
+True if the error is empty.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isEmpty`](BaseError.md#isempty)
+
+***
+
+### isAggregateError()
+
+> `static` **isAggregateError**(`err`): `err is AggregateError`
+
+Is the error an aggregate error.
+
+#### Parameters
+
+##### err
+
+`unknown`
+
+The error to check for being an aggregate error.
+
+#### Returns
+
+`err is AggregateError`
+
+True if the error is an aggregate error.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isAggregateError`](BaseError.md#isaggregateerror)
+
+***
+
+### fromAggregate()
+
+> `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
+
+Convert the aggregate error to an array of errors.
+
+#### Parameters
+
+##### err
+
+`unknown`
+
+The error to convert.
+
+##### includeStackTrace?
+
+`boolean`
+
+Whether to include the error stack in the model, defaults to false.
+
+#### Returns
+
+[`IError`](../interfaces/IError.md)[]
+
+The array of errors.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`fromAggregate`](BaseError.md#fromaggregate)
+
+***
+
 ### toJsonObject()
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)

package/docs/reference/classes/Guards.md

@@ -618,7 +618,7 @@ Is the property an object.
 
 ##### T
 
-`T` = \{[`id`: `string`]: `unknown`; \}
+`T` = \{\[`id`: `string`\]: `unknown`; \}
 
 #### Parameters
 
@@ -660,7 +660,7 @@ Is the property is an object with at least one property.
 
 ##### T
 
-`T` = \{[`id`: `string`]: `unknown`; \}
+`T` = \{\[`id`: `string`\]: `unknown`; \}
 
 #### Parameters
 

package/docs/reference/classes/I18n.md

@@ -84,7 +84,7 @@ The dictionary to add.
 
 ### getDictionary()
 
-> `static` **getDictionary**(`locale`): `undefined` \| \{[`key`: `string`]: `string`; \}
+> `static` **getDictionary**(`locale`): `undefined` \| \{\[`key`: `string`\]: `string`; \}
 
 Get a locale dictionary.
 
@@ -98,7 +98,7 @@ The locale.
 
 #### Returns
 
-`undefined` \| \{[`key`: `string`]: `string`; \}
+`undefined` \| \{\[`key`: `string`\]: `string`; \}
 
 The dictionary of undefined if it does not exist.
 

package/docs/reference/classes/Is.md

@@ -548,7 +548,7 @@ Is the value an object.
 
 ##### T
 
-`T` = \{[`id`: `string`]: `unknown`; \}
+`T` = \{\[`id`: `string`\]: `unknown`; \}
 
 #### Parameters
 
@@ -576,7 +576,7 @@ Is the value an object with at least one property.
 
 ##### T
 
-`T` = \{[`id`: `string`]: `unknown`; \}
+`T` = \{\[`id`: `string`\]: `unknown`; \}
 
 #### Parameters
 
@@ -819,3 +819,31 @@ The value to test.
 `value is RegExp`
 
 True if the value is a regexp.
+
+***
+
+### class()
+
+> `static` **class**\<`T`\>(`obj`): `obj is (args: any[]) => T`
+
+Is the provided object a class constructor.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### obj
+
+`unknown`
+
+The object to check.
+
+#### Returns
+
+`obj is (args: any[]) => T`
+
+True if the object is a class, false otherwise.