@twin.org/core 0.0.1-next.9 → 0.0.2-next.10

package/docs/reference/classes/JsonHelper.md

@@ -4,13 +4,13 @@ Helpers methods for JSON objects.
 
 ## Constructors
 
-### new JsonHelper()
+### Constructor
 
-> **new JsonHelper**(): [`JsonHelper`](JsonHelper.md)
+> **new JsonHelper**(): `JsonHelper`
 
 #### Returns
 
-[`JsonHelper`](JsonHelper.md)
+`JsonHelper`
 
 ## Methods
 
@@ -23,7 +23,9 @@ Based on https://www.rfc-editor.org/rfc/rfc8785.
 
 #### Parameters
 
-• **object**: `unknown`
+##### object
+
+`unknown`
 
 The object to be serialized.
 
@@ -44,15 +46,21 @@ Based on https://www.rfc-editor.org/rfc/rfc6902.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **object1**: `T`
+##### object1
+
+`T`
 
 The first object.
 
-• **object2**: `T`
+##### object2
+
+`T`
 
 The second object.
 
@@ -73,15 +81,21 @@ Based on https://www.rfc-editor.org/rfc/rfc6902.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **object**: `T`
+##### object
+
+`T`
 
 The object to patch.
 
-• **patches**: [`IPatchOperation`](../interfaces/IPatchOperation.md)[]
+##### patches
+
+[`IPatchOperation`](../interfaces/IPatchOperation.md)[]
 
 The second object.
 
@@ -90,3 +104,125 @@ The second object.
 `T`
 
 The updated object.
+
+#### Throws
+
+GeneralError if the patch fails.
+
+***
+
+### stringifyEx()
+
+> `static` **stringifyEx**(`object`, `space?`): `string`
+
+Stringify the JSON with support for extended data types date/bigint/uint8array.
+
+#### Parameters
+
+##### object
+
+`any`
+
+The object to stringify.
+
+##### space?
+
+Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
+
+`string` | `number`
+
+#### Returns
+
+`string`
+
+The stringified object.
+
+***
+
+### parseEx()
+
+> `static` **parseEx**(`json`): `any`
+
+Parse the JSON string with support for extended data types date/bigint/uint8array.
+
+#### Parameters
+
+##### json
+
+`string`
+
+The object to pause.
+
+#### Returns
+
+`any`
+
+The object.
+
+***
+
+### stringifyExReplacer()
+
+> `static` **stringifyExReplacer**(`this`, `key`, `value`): `unknown`
+
+Replacer function to handle extended data types.
+
+#### Parameters
+
+##### this
+
+`any`
+
+The object.
+
+##### key
+
+`string`
+
+The key.
+
+##### value
+
+`unknown`
+
+The value.
+
+#### Returns
+
+`unknown`
+
+The value.
+
+***
+
+### parseExReviver()
+
+> `static` **parseExReviver**(`this`, `key`, `value`): `unknown`
+
+Reviver function to handle extended data types.
+
+#### Parameters
+
+##### this
+
+`any`
+
+The object.
+
+##### key
+
+`string`
+
+The key.
+
+##### value
+
+`unknown`
+
+The value.
+
+#### Returns
+
+`unknown`
+
+The value.

package/docs/reference/classes/NotFoundError.md

@@ -8,37 +8,45 @@ Class to handle errors which are triggered by data not being found.
 
 ## Constructors
 
-### new NotFoundError()
+### Constructor
 
-> **new NotFoundError**(`source`, `message`, `notFoundId`?, `inner`?): [`NotFoundError`](NotFoundError.md)
+> **new NotFoundError**(`source`, `message`, `notFoundId?`, `cause?`): `NotFoundError`
 
 Create a new instance of NotFoundError.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message as a code.
 
-• **notFoundId?**: `string`
+##### notFoundId?
+
+`string`
 
 The id for the item.
 
-• **inner?**: `unknown`
+##### cause?
 
-The inner error if we have wrapped another error.
+`unknown`
+
+The cause of the error if we have wrapped another error.
 
 #### Returns
 
-[`NotFoundError`](NotFoundError.md)
+`NotFoundError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -62,7 +70,7 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Inherited from
 
@@ -70,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)
 
 ***
 
@@ -98,7 +106,9 @@ Construct an error from an existing one.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The existing error.
 
@@ -122,7 +132,9 @@ Flatten an error tree.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The starting error.
 
@@ -146,10 +158,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 +184,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 +216,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 +248,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 +280,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 +312,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 +344,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 +376,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`
@@ -358,12 +400,104 @@ 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**(): [`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)