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

package/docs/reference/classes/NotSupportedError.md

@@ -8,33 +8,39 @@ Class to handle errors when a feature is unsupported.
 
 ## Constructors
 
-### new NotSupportedError()
+### Constructor
 
-> **new NotSupportedError**(`source`, `message`, `inner`?): [`NotSupportedError`](NotSupportedError.md)
+> **new NotSupportedError**(`source`, `message`, `inner?`): `NotSupportedError`
 
 Create a new instance of NotSupportedError.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message as a code.
 
-• **inner?**: `unknown`
+##### inner?
+
+`unknown`
 
 The inner error if we have wrapped another error.
 
 #### Returns
 
-[`NotSupportedError`](NotSupportedError.md)
+`NotSupportedError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -58,7 +64,7 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Inherited from
 
@@ -94,7 +100,9 @@ Construct an error from an existing one.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The existing error.
 
@@ -118,7 +126,9 @@ Flatten an error tree.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The starting error.
 
@@ -142,10 +152,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)
@@ -166,14 +178,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`
@@ -194,14 +210,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`
@@ -222,14 +242,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`
@@ -250,14 +274,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`
@@ -278,14 +306,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`
@@ -306,11 +338,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.
 
@@ -334,14 +370,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`
@@ -354,12 +394,46 @@ True if the error has the name.
 
 ***
 
+### isEmpty()
+
+> `static` **isEmpty**(`err`): `boolean`
+
+Is the error empty.
+
+#### 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)
+
+***
+
 ### 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)

package/docs/reference/classes/ObjectHelper.md

@@ -4,13 +4,13 @@ Class to help with objects.
 
 ## Constructors
 
-### new ObjectHelper()
+### Constructor
 
-> **new ObjectHelper**(): [`ObjectHelper`](ObjectHelper.md)
+> **new ObjectHelper**(): `ObjectHelper`
 
 #### Returns
 
-[`ObjectHelper`](ObjectHelper.md)
+`ObjectHelper`
 
 ## Methods
 
@@ -22,15 +22,21 @@ Convert an object to bytes.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **obj**: `undefined` \| `T`
+##### obj
 
 The object to convert.
 
-• **format**: `boolean` = `false`
+`undefined` | `T`
+
+##### format
+
+`boolean` = `false`
 
 Format the JSON content.
 
@@ -50,14 +56,18 @@ Convert a bytes to an object.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **bytes**: `undefined` \| `null` \| `Uint8Array`
+##### bytes
 
 The bytes to convert to an object.
 
+`undefined` | `null` | `Uint8Array`\<`ArrayBufferLike`\>
+
 #### Returns
 
 `T`
@@ -78,11 +88,15 @@ Make a deep clone of an object.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **obj**: `T`
+##### obj
+
+`T`
 
 The object to clone.
 
@@ -102,17 +116,25 @@ Deep merge objects.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
 
-• **U** = `unknown`
+`T` = `unknown`
+
+##### U
+
+`U` = `unknown`
 
 #### Parameters
 
-• **obj1**: `T`
+##### obj1
+
+`T`
 
 The first object to merge.
 
-• **obj2**: `U`
+##### obj2
+
+`U`
 
 The second object to merge.
 
@@ -126,25 +148,33 @@ The combined deep merge of the objects.
 
 ### equal()
 
-> `static` **equal**\<`T`\>(`obj1`, `obj2`, `strictPropertyOrder`?): `boolean`
+> `static` **equal**\<`T`\>(`obj1`, `obj2`, `strictPropertyOrder?`): `boolean`
 
 Does one object equal another.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **obj1**: `T`
+##### obj1
+
+`T`
 
 The first object to compare.
 
-• **obj2**: `T`
+##### obj2
+
+`T`
 
 The second object to compare.
 
-• **strictPropertyOrder?**: `boolean`
+##### strictPropertyOrder?
+
+`boolean`
 
 Should the properties be in the same order, defaults to true.
 
@@ -164,15 +194,21 @@ Get the property of an unknown object.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **obj**: `unknown`
+##### obj
+
+`unknown`
 
 The object to get the property from.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The property to get, can be separated by dots for nested path.
 
@@ -192,15 +228,21 @@ Set the property of an unknown object.
 
 #### Parameters
 
-• **obj**: `unknown`
+##### obj
+
+`unknown`
 
 The object to set the property from.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The property to set.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to set.
 
@@ -208,6 +250,10 @@ The value to set.
 
 `void`
 
+#### Throws
+
+GeneralError if the property target is not an object.
+
 ***
 
 ### propertyDelete()
@@ -218,11 +264,15 @@ Delete the property of an unknown object.
 
 #### Parameters
 
-• **obj**: `unknown`
+##### obj
+
+`unknown`
 
 The object to set the property from.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The property to set
 
@@ -240,19 +290,27 @@ Extract a property from the object, providing alternative names.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **obj**: `unknown`
+##### obj
+
+`unknown`
 
 The object to extract from.
 
-• **propertyNames**: `string` \| `string`[]
+##### propertyNames
 
 The possible names for the property.
 
-• **removeProperties**: `boolean` = `true`
+`string` | `string`[]
+
+##### removeProperties
+
+`boolean` = `true`
 
 Remove the properties from the object, defaults to true.
 
@@ -266,21 +324,27 @@ The property if available.
 
 ### pick()
 
-> `static` **pick**\<`T`\>(`obj`, `keys`?): `Partial`\<`T`\>
+> `static` **pick**\<`T`\>(`obj`, `keys?`): `Partial`\<`T`\>
 
 Pick a subset of properties from an object.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **obj**: `undefined` \| `T`
+##### obj
 
 The object to pick the properties from.
 
-• **keys?**: keyof `T`[]
+`undefined` | `T`
+
+##### keys?
+
+keyof `T`[]
 
 The property keys to pick.
 
@@ -294,21 +358,27 @@ The partial object.
 
 ### omit()
 
-> `static` **omit**\<`T`\>(`obj`, `keys`?): `Partial`\<`T`\>
+> `static` **omit**\<`T`\>(`obj`, `keys?`): `Partial`\<`T`\>
 
 Omit a subset of properties from an object.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **obj**: `undefined` \| `T`
+##### obj
 
 The object to omit the properties from.
 
-• **keys?**: keyof `T`[]
+`undefined` | `T`
+
+##### keys?
+
+keyof `T`[]
 
 The property keys to omit.
 
@@ -317,3 +387,91 @@ The property keys to omit.
 `Partial`\<`T`\>
 
 The partial object.
+
+***
+
+### toExtended()
+
+> `static` **toExtended**(`obj`): `any`
+
+Converter the non JSON primitives to extended types.
+
+#### Parameters
+
+##### obj
+
+`any`
+
+The object to convert.
+
+#### Returns
+
+`any`
+
+The object with extended properties.
+
+***
+
+### fromExtended()
+
+> `static` **fromExtended**(`obj`): `any`
+
+Converter the extended types to non JSON primitives.
+
+#### Parameters
+
+##### obj
+
+`any`
+
+The object to convert.
+
+#### Returns
+
+`any`
+
+The object with regular properties.
+
+***
+
+### removeEmptyProperties()
+
+> `static` **removeEmptyProperties**\<`T`\>(`obj`, `options?`): `T`
+
+Remove empty properties from an object.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### obj
+
+`T`
+
+The object to remove the empty properties from.
+
+##### options?
+
+The options for the removal.
+
+###### removeUndefined?
+
+`boolean`
+
+Remove undefined properties, defaults to true.
+
+###### removeNull?
+
+`boolean`
+
+Remove null properties, defaults to false.
+
+#### Returns
+
+`T`
+
+The object with empty properties removed.

package/docs/reference/classes/RandomHelper.md

@@ -4,13 +4,13 @@ Class to help with random generation.
 
 ## Constructors
 
-### new RandomHelper()
+### Constructor
 
-> **new RandomHelper**(): [`RandomHelper`](RandomHelper.md)
+> **new RandomHelper**(): `RandomHelper`
 
 #### Returns
 
-[`RandomHelper`](RandomHelper.md)
+`RandomHelper`
 
 ## Methods
 
@@ -22,7 +22,9 @@ Generate a new random array.
 
 #### Parameters
 
-• **length**: `number`
+##### length
+
+`number`
 
 The length of buffer to create.