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

package/docs/reference/classes/NotSupportedError.md

@@ -10,7 +10,7 @@ Class to handle errors when a feature is unsupported.
 
 ### Constructor
 
-> **new NotSupportedError**(`source`, `message`, `cause?`): `NotSupportedError`
+> **new NotSupportedError**(`source`, `message`, `properties?`, `cause?`): `NotSupportedError`
 
 Create a new instance of NotSupportedError.
 
@@ -26,7 +26,11 @@ The source of the error.
 
 `string`
 
-The message as a code.
+The message as an i18n key.
+
+##### properties?
+
+Any additional information for the error.
 
 ##### cause?
 
@@ -44,9 +48,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.
 
@@ -56,9 +60,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -72,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.
 
@@ -84,7 +88,7 @@ The cause of the error.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -92,7 +96,7 @@ Runtime name for the class.
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
 
@@ -118,7 +122,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -144,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.
 
@@ -154,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.
 
@@ -170,7 +174,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -186,9 +190,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -202,7 +206,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -218,9 +222,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -234,7 +238,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -250,9 +254,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -266,7 +270,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -282,9 +286,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -298,7 +302,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -314,9 +318,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -330,7 +334,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -362,7 +366,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -378,9 +382,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -394,7 +398,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -420,7 +424,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -446,7 +450,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -478,7 +482,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 

package/docs/reference/classes/NumberHelper.md

@@ -0,0 +1,55 @@
+# Class: NumberHelper
+
+Class to help with numbers.
+
+## Constructors
+
+### Constructor
+
+> **new NumberHelper**(): `NumberHelper`
+
+#### Returns
+
+`NumberHelper`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### clamp() {#clamp}
+
+> `static` **clamp**(`value`, `minValue?`, `maxValue?`): `number`
+
+Clamps a number between a minimum and maximum value.
+
+#### Parameters
+
+##### value
+
+`number`
+
+The value to clamp.
+
+##### minValue?
+
+`number`
+
+The minimum value.
+
+##### maxValue?
+
+`number`
+
+The maximum value.
+
+#### Returns
+
+`number`
+
+The clamped value.

package/docs/reference/classes/ObjectHelper.md

@@ -12,11 +12,19 @@ Class to help with objects.
 
 `ObjectHelper`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### toBytes()
+### toBytes() {#tobytes}
 
-> `static` **toBytes**\<`T`\>(`obj`, `format`): `Uint8Array`
+> `static` **toBytes**\<`T`\>(`obj`, `format?`): `Uint8Array`
 
 Convert an object to bytes.
 
@@ -30,11 +38,11 @@ Convert an object to bytes.
 
 ##### obj
 
-The object to convert.
+`T` \| `undefined`
 
-`undefined` | `T`
+The object to convert.
 
-##### format
+##### format?
 
 `boolean` = `false`
 
@@ -48,7 +56,7 @@ The object as bytes.
 
 ***
 
-### fromBytes()
+### fromBytes() {#frombytes}
 
 > `static` **fromBytes**\<`T`\>(`bytes`): `T`
 
@@ -64,9 +72,9 @@ Convert a bytes to an object.
 
 ##### bytes
 
-The bytes to convert to an object.
+`Uint8Array`\<`ArrayBufferLike`\> \| `null` \| `undefined`
 
-`undefined` | `null` | `Uint8Array`\<`ArrayBufferLike`\>
+The bytes to convert to an object.
 
 #### Returns
 
@@ -80,7 +88,7 @@ GeneralError if there was an error parsing the JSON.
 
 ***
 
-### clone()
+### clone() {#clone}
 
 > `static` **clone**\<`T`\>(`obj`): `T`
 
@@ -108,7 +116,7 @@ The objects clone.
 
 ***
 
-### merge()
+### merge() {#merge}
 
 > `static` **merge**\<`T`, `U`\>(`obj1`, `obj2`): `T` & `U`
 
@@ -146,7 +154,7 @@ The combined deep merge of the objects.
 
 ***
 
-### equal()
+### equal() {#equal}
 
 > `static` **equal**\<`T`\>(`obj1`, `obj2`, `strictPropertyOrder?`): `boolean`
 
@@ -186,9 +194,9 @@ True is the objects are equal.
 
 ***
 
-### propertyGet()
+### propertyGet() {#propertyget}
 
-> `static` **propertyGet**\<`T`\>(`obj`, `property`): `undefined` \| `T`
+> `static` **propertyGet**\<`T`\>(`obj`, `property`): `T` \| `undefined`
 
 Get the property of an unknown object.
 
@@ -214,13 +222,13 @@ The property to get, can be separated by dots for nested path.
 
 #### Returns
 
-`undefined` \| `T`
+`T` \| `undefined`
 
 The property.
 
 ***
 
-### propertySet()
+### propertySet() {#propertyset}
 
 > `static` **propertySet**(`obj`, `property`, `value`): `void`
 
@@ -256,7 +264,7 @@ GeneralError if the property target is not an object.
 
 ***
 
-### propertyDelete()
+### propertyDelete() {#propertydelete}
 
 > `static` **propertyDelete**(`obj`, `property`): `void`
 
@@ -268,13 +276,13 @@ Delete the property of an unknown object.
 
 `unknown`
 
-The object to set the property from.
+The object to delete the property from.
 
 ##### property
 
 `string`
 
-The property to set
+The property to delete.
 
 #### Returns
 
@@ -282,9 +290,9 @@ The property to set
 
 ***
 
-### extractProperty()
+### extractProperty() {#extractproperty}
 
-> `static` **extractProperty**\<`T`\>(`obj`, `propertyNames`, `removeProperties`): `undefined` \| `T`
+> `static` **extractProperty**\<`T`\>(`obj`, `propertyNames`, `removeProperties?`): `T` \| `undefined`
 
 Extract a property from the object, providing alternative names.
 
@@ -304,11 +312,11 @@ The object to extract from.
 
 ##### propertyNames
 
-The possible names for the property.
+`string` \| `string`[]
 
-`string` | `string`[]
+The possible names for the property.
 
-##### removeProperties
+##### removeProperties?
 
 `boolean` = `true`
 
@@ -316,81 +324,185 @@ Remove the properties from the object, defaults to true.
 
 #### Returns
 
-`undefined` \| `T`
+`T` \| `undefined`
 
 The property if available.
 
 ***
 
-### pick()
+### pick() {#pick}
 
-> `static` **pick**\<`T`\>(`obj`, `keys?`): `Partial`\<`T`\>
+Pick a subset of properties from an object.
+
+#### Param
+
+The object to pick the properties from.
+
+#### Param
+
+The property keys to pick.
+
+#### Call Signature
+
+> `static` **pick**\<`T`, `K`\>(`obj`, `keys?`): `Pick`\<`T`, `K`\>
 
 Pick a subset of properties from an object.
 
-#### Type Parameters
+##### Type Parameters
 
-##### T
+###### T
 
 `T`
 
-#### Parameters
+###### K
 
-##### obj
+`K` *extends* `string` \| `number` \| `symbol`
+
+##### Parameters
+
+###### obj
+
+`T`
 
 The object to pick the properties from.
 
-`undefined` | `T`
+###### keys?
+
+`K`[]
+
+The property keys to pick.
+
+##### Returns
+
+`Pick`\<`T`, `K`\>
+
+The picked object.
+
+#### Call Signature
+
+> `static` **pick**\<`T`, `K`\>(`obj`, `keys?`): `Pick`\<`T`, `K`\> \| `undefined`
+
+Pick a subset of properties from an object.
+
+##### Type Parameters
+
+###### T
+
+`T`
+
+###### K
+
+`K` *extends* `string` \| `number` \| `symbol`
+
+##### Parameters
 
-##### keys?
+###### obj
 
-keyof `T`[]
+`T` \| `undefined`
+
+The object to pick the properties from.
+
+###### keys?
+
+`K`[]
 
 The property keys to pick.
 
-#### Returns
+##### Returns
 
-`Partial`\<`T`\>
+`Pick`\<`T`, `K`\> \| `undefined`
 
-The partial object.
+The picked object, or undefined if the input was undefined.
 
 ***
 
-### omit()
+### omit() {#omit}
+
+Omit a subset of properties from an object.
+
+#### Param
+
+The object to omit the properties from.
+
+#### Param
 
-> `static` **omit**\<`T`\>(`obj`, `keys?`): `Partial`\<`T`\>
+The property keys to omit.
+
+#### Call Signature
+
+> `static` **omit**\<`T`, `K`\>(`obj`, `keys?`): `Omit`\<`T`, `K`\>
 
 Omit a subset of properties from an object.
 
-#### Type Parameters
+##### Type Parameters
 
-##### T
+###### T
 
 `T`
 
-#### Parameters
+###### K
 
-##### obj
+`K` *extends* `string` \| `number` \| `symbol`
+
+##### Parameters
+
+###### obj
+
+`T`
 
 The object to omit the properties from.
 
-`undefined` | `T`
+###### keys?
 
-##### keys?
+`K`[]
 
-keyof `T`[]
+The property keys to omit.
+
+##### Returns
+
+`Omit`\<`T`, `K`\>
+
+The object without the omitted keys.
+
+#### Call Signature
+
+> `static` **omit**\<`T`, `K`\>(`obj`, `keys?`): `Omit`\<`T`, `K`\> \| `undefined`
+
+Omit a subset of properties from an object.
+
+##### Type Parameters
+
+###### T
+
+`T`
+
+###### K
+
+`K` *extends* `string` \| `number` \| `symbol`
+
+##### Parameters
+
+###### obj
+
+`T` \| `undefined`
+
+The object to omit the properties from.
+
+###### keys?
+
+`K`[]
 
 The property keys to omit.
 
-#### Returns
+##### Returns
 
-`Partial`\<`T`\>
+`Omit`\<`T`, `K`\> \| `undefined`
 
-The partial object.
+The object without the omitted keys, or undefined if the input was undefined.
 
 ***
 
-### toExtended()
+### toExtended() {#toextended}
 
 > `static` **toExtended**(`obj`): `any`
 
@@ -412,7 +524,7 @@ The object with extended properties.
 
 ***
 
-### fromExtended()
+### fromExtended() {#fromextended}
 
 > `static` **fromExtended**(`obj`): `any`
 
@@ -434,7 +546,7 @@ The object with regular properties.
 
 ***
 
-### removeEmptyProperties()
+### removeEmptyProperties() {#removeemptyproperties}
 
 > `static` **removeEmptyProperties**\<`T`\>(`obj`, `options?`): `T`