@twin.org/core 0.0.2-next.3 → 0.0.2-next.5

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)
 
 ***
 
@@ -402,7 +402,7 @@ True if the error has the name.
 
 > `static` **isEmpty**(`err`): `boolean`
 
-Is the error empty.
+Is the error empty, i.e. does it have no message, source, properties, or cause?
 
 #### Parameters
 
@@ -424,6 +424,64 @@ 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.
+
+#### 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)
 
 ***
 
@@ -410,7 +410,7 @@ True if the error has the name.
 
 > `static` **isEmpty**(`err`): `boolean`
 
-Is the error empty.
+Is the error empty, i.e. does it have no message, source, properties, or cause?
 
 #### Parameters
 
@@ -432,6 +432,64 @@ 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.
+
+#### 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
 

package/docs/reference/classes/NotFoundError.md

@@ -10,7 +10,7 @@ Class to handle errors which are triggered by data not being found.
 
 ### Constructor
 
-> **new NotFoundError**(`source`, `message`, `notFoundId?`, `inner?`): `NotFoundError`
+> **new NotFoundError**(`source`, `message`, `notFoundId?`, `cause?`): `NotFoundError`
 
 Create a new instance of NotFoundError.
 
@@ -34,11 +34,11 @@ The message as a code.
 
 The id for the item.
 
-##### inner?
+##### cause?
 
 `unknown`
 
-The inner error if we have wrapped another error.
+The cause of the error if we have wrapped another error.
 
 #### Returns
 
@@ -78,15 +78,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)
 
 ***
 
@@ -404,7 +404,7 @@ True if the error has the name.
 
 > `static` **isEmpty**(`err`): `boolean`
 
-Is the error empty.
+Is the error empty, i.e. does it have no message, source, properties, or cause?
 
 #### Parameters
 
@@ -426,6 +426,64 @@ 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.
+
+#### 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/NotImplementedError.md

@@ -66,15 +66,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)
 
 ***
 
@@ -392,7 +392,7 @@ True if the error has the name.
 
 > `static` **isEmpty**(`err`): `boolean`
 
-Is the error empty.
+Is the error empty, i.e. does it have no message, source, properties, or cause?
 
 #### Parameters
 
@@ -414,6 +414,64 @@ 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.
+
+#### 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/NotSupportedError.md

@@ -10,7 +10,7 @@ Class to handle errors when a feature is unsupported.
 
 ### Constructor
 
-> **new NotSupportedError**(`source`, `message`, `inner?`): `NotSupportedError`
+> **new NotSupportedError**(`source`, `message`, `cause?`): `NotSupportedError`
 
 Create a new instance of NotSupportedError.
 
@@ -28,11 +28,11 @@ The source of the error.
 
 The message as a code.
 
-##### inner?
+##### cause?
 
 `unknown`
 
-The inner error if we have wrapped another error.
+The cause of the error if we have wrapped another error.
 
 #### Returns
 
@@ -72,15 +72,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,7 +398,7 @@ True if the error has the name.
 
 > `static` **isEmpty**(`err`): `boolean`
 
-Is the error empty.
+Is the error empty, i.e. does it have no message, source, properties, or cause?
 
 #### Parameters
 
@@ -420,6 +420,64 @@ 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.
+
+#### 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/UnauthorizedError.md

@@ -10,7 +10,7 @@ Class to handle errors which are triggered by access not being unauthorized.
 
 ### Constructor
 
-> **new UnauthorizedError**(`source`, `message`, `inner?`): `UnauthorizedError`
+> **new UnauthorizedError**(`source`, `message`, `cause?`): `UnauthorizedError`
 
 Create a new instance of UnauthorizedError.
 
@@ -28,11 +28,11 @@ The source of the error.
 
 The message as a code.
 
-##### inner?
+##### cause?
 
 `unknown`
 
-The inner error if we have wrapped another error.
+The cause of the error if we have wrapped another error.
 
 #### Returns
 
@@ -72,15 +72,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,7 +398,7 @@ True if the error has the name.
 
 > `static` **isEmpty**(`err`): `boolean`
 
-Is the error empty.
+Is the error empty, i.e. does it have no message, source, properties, or cause?
 
 #### Parameters
 
@@ -420,6 +420,64 @@ 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.
+
+#### 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)