@twin.org/core 0.0.2-next.8 → 0.0.2

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?`, `cause?`): `NotFoundError`
+> **new NotFoundError**(`source`, `message`, `notFoundId?`, `properties?`, `cause?`): `NotFoundError`
 
 Create a new instance of NotFoundError.
 
@@ -26,7 +26,7 @@ The source of the error.
 
 `string`
 
-The message as a code.
+The message as an i18n key.
 
 ##### notFoundId?
 
@@ -34,6 +34,10 @@ The message as a code.
 
 The id for the item.
 
+##### properties?
+
+Any additional information for the error.
+
 ##### cause?
 
 `unknown`
@@ -50,9 +54,9 @@ The cause of the error if we have wrapped another error.
 
 ## Properties
 
-### source?
+### source? {#source}
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
 The source of the error.
 
@@ -62,9 +66,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -78,9 +82,9 @@ Any additional information for the error.
 
 ***
 
-### cause?
+### cause? {#cause}
 
-> `optional` **cause**: [`IError`](../interfaces/IError.md)
+> `optional` **cause?**: [`IError`](../interfaces/IError.md)
 
 The cause of the error.
 
@@ -90,7 +94,7 @@ The cause of the error.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -98,7 +102,7 @@ Runtime name for the class.
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
 
@@ -124,7 +128,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -150,9 +154,9 @@ The list of all internal errors.
 
 ***
 
-### expand()
+### expand() {#expand}
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -160,13 +164,13 @@ Expand an error tree.
 
 ##### errors
 
-The list of errors to expand.
+[`IError`](../interfaces/IError.md)[] \| `undefined`
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+The list of errors to expand.
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 
@@ -176,7 +180,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -192,9 +196,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -208,7 +212,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -224,9 +228,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -240,7 +244,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -256,9 +260,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -272,7 +276,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -288,9 +292,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -304,7 +308,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -320,9 +324,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -336,7 +340,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -368,7 +372,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -384,9 +388,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -400,7 +404,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -426,7 +430,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -452,7 +456,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -484,7 +488,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 

package/docs/reference/classes/NotImplementedError.md

@@ -10,7 +10,7 @@ Class to handle errors.
 
 ### Constructor
 
-> **new NotImplementedError**(`source`, `method`): `NotImplementedError`
+> **new NotImplementedError**(`source`, `method`, `properties?`, `cause?`): `NotImplementedError`
 
 Create a new instance of NotImplementedError.
 
@@ -28,6 +28,16 @@ The source of the error.
 
 The method for the error.
 
+##### properties?
+
+Any additional information for the error.
+
+##### cause?
+
+`unknown`
+
+The cause of the error if we have wrapped another error.
+
 #### Returns
 
 `NotImplementedError`
@@ -38,9 +48,9 @@ The method for the error.
 
 ## Properties
 
-### source?
+### source? {#source}
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
 The source of the error.
 
@@ -50,9 +60,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -66,9 +76,9 @@ Any additional information for the error.
 
 ***
 
-### cause?
+### cause? {#cause}
 
-> `optional` **cause**: [`IError`](../interfaces/IError.md)
+> `optional` **cause?**: [`IError`](../interfaces/IError.md)
 
 The cause of the error.
 
@@ -78,7 +88,7 @@ The cause of the error.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -86,7 +96,7 @@ Runtime name for the class.
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
 
@@ -112,7 +122,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -138,9 +148,9 @@ The list of all internal errors.
 
 ***
 
-### expand()
+### expand() {#expand}
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -148,13 +158,13 @@ Expand an error tree.
 
 ##### errors
 
-The list of errors to expand.
+[`IError`](../interfaces/IError.md)[] \| `undefined`
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+The list of errors to expand.
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 
@@ -164,7 +174,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -180,9 +190,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -196,7 +206,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -212,9 +222,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -228,7 +238,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -244,9 +254,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -260,7 +270,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -276,9 +286,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -292,7 +302,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -308,9 +318,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -324,7 +334,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -356,7 +366,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -372,9 +382,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -388,7 +398,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -414,7 +424,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -440,7 +450,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -472,7 +482,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)