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

package/docs/reference/classes/UnprocessableError.md

@@ -10,7 +10,7 @@ Class to handle errors when some data can not be processed.
 
 ### Constructor
 
-> **new UnprocessableError**(`source`, `message`, `properties?`, `inner?`): `UnprocessableError`
+> **new UnprocessableError**(`source`, `message`, `properties?`, `cause?`): `UnprocessableError`
 
 Create a new instance of UnprocessableError.
 
@@ -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/Validation.md

@@ -670,7 +670,7 @@ Is the property an object.
 
 ##### T
 
-`T` = \{[`id`: `string`]: `unknown`; \}
+`T` = \{\[`id`: `string`\]: `unknown`; \}
 
 #### Parameters
 

package/docs/reference/classes/ValidationError.md

@@ -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/interfaces/IComponent.md

@@ -14,22 +14,18 @@ The name of the component.
 
 ### bootstrap()?
 
-> `optional` **bootstrap**(`nodeLoggingConnectorType`, `componentState?`): `Promise`\<`boolean`\>
+> `optional` **bootstrap**(`nodeLoggingComponentType`): `Promise`\<`boolean`\>
 
 Bootstrap the component by creating and initializing any resources it needs.
 
 #### Parameters
 
-##### nodeLoggingConnectorType
+##### nodeLoggingComponentType
 
-The node logging connector type, defaults to "node-logging".
+The node logging component type.
 
 `undefined` | `string`
 
-##### componentState?
-
-A persistent state which can be modified by the method.
-
 #### Returns
 
 `Promise`\<`boolean`\>
@@ -40,7 +36,7 @@ True if the bootstrapping process was successful.
 
 ### start()?
 
-> `optional` **start**(`nodeIdentity`, `nodeLoggingConnectorType`, `componentState?`): `Promise`\<`void`\>
+> `optional` **start**(`nodeIdentity`, `nodeLoggingComponentType`): `Promise`\<`void`\>
 
 The component needs to be started when the node is initialized.
 
@@ -52,16 +48,12 @@ The component needs to be started when the node is initialized.
 
 The identity of the node starting the component.
 
-##### nodeLoggingConnectorType
+##### nodeLoggingComponentType
 
-The node logging connector type, defaults to "node-logging".
+The node logging component type.
 
 `undefined` | `string`
 
-##### componentState?
-
-A persistent state which can be modified by the method.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -72,7 +64,7 @@ Nothing.
 
 ### stop()?
 
-> `optional` **stop**(`nodeIdentity`, `nodeLoggingConnectorType`, `componentState?`): `Promise`\<`void`\>
+> `optional` **stop**(`nodeIdentity`, `nodeLoggingComponentType`): `Promise`\<`void`\>
 
 The component needs to be stopped when the node is closed.
 
@@ -84,16 +76,12 @@ The component needs to be stopped when the node is closed.
 
 The identity of the node stopping the component.
 
-##### nodeLoggingConnectorType
+##### nodeLoggingComponentType
 
-The node logging connector type, defaults to "node-logging".
+The node logging component type.
 
 `undefined` | `string`
 
-##### componentState?
-
-A persistent state which can be modified by the method.
-
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/interfaces/IError.md

@@ -48,8 +48,8 @@ The stack trace for the error.
 
 ***
 
-### inner?
+### cause?
 
-> `optional` **inner**: `IError`
+> `optional` **cause**: `IError`
 
-The inner error if there was one.
+The cause of the error if there was one.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.2-next.3",
+	"version": "0.0.2-next.5",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/nameof": "0.0.2-next.3",
+		"@twin.org/nameof": "0.0.2-next.5",
 		"intl-messageformat": "10.7.16",
 		"rfc6902": "5.1.2"
 	},