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

package/docs/reference/classes/NotSupportedError.md

@@ -26,7 +26,7 @@ The source of the error.
 
 `string`
 
-The message as a code.
+The message as an i18n key.
 
 ##### properties?
 
@@ -48,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.
 
@@ -60,9 +60,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -76,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.
 
@@ -88,7 +88,7 @@ The cause of the error.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -96,7 +96,7 @@ Runtime name for the class.
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
 
@@ -122,7 +122,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -148,7 +148,7 @@ The list of all internal errors.
 
 ***
 
-### expand()
+### expand() {#expand}
 
 > `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
@@ -158,9 +158,9 @@ Expand an error tree.
 
 ##### errors
 
-The list of errors to expand.
+[`IError`](../interfaces/IError.md)[] \| `undefined`
 
-[`IError`](../interfaces/IError.md)[] | `undefined`
+The list of errors to expand.
 
 #### Returns
 
@@ -174,7 +174,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -190,9 +190,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -206,7 +206,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -222,9 +222,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -238,7 +238,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -254,9 +254,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -270,7 +270,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -286,9 +286,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -302,7 +302,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -318,9 +318,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -334,7 +334,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -366,7 +366,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -382,9 +382,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -398,7 +398,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -424,7 +424,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -450,7 +450,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -482,7 +482,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 

package/docs/reference/classes/NumberHelper.md

@@ -14,7 +14,7 @@ Class to help with numbers.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### clamp()
+### clamp() {#clamp}
 
 > `static` **clamp**(`value`, `minValue?`, `maxValue?`): `number`
 

package/docs/reference/classes/ObjectHelper.md

@@ -14,7 +14,7 @@ Class to help with objects.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,9 +22,9 @@ 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.
 
@@ -38,11 +38,11 @@ Convert an object to bytes.
 
 ##### obj
 
-The object to convert.
+`T` \| `undefined`
 
-`T` | `undefined`
+The object to convert.
 
-##### format
+##### format?
 
 `boolean` = `false`
 
@@ -56,7 +56,7 @@ The object as bytes.
 
 ***
 
-### fromBytes()
+### fromBytes() {#frombytes}
 
 > `static` **fromBytes**\<`T`\>(`bytes`): `T`
 
@@ -72,9 +72,9 @@ Convert a bytes to an object.
 
 ##### bytes
 
-The bytes to convert to an object.
+`Uint8Array`\<`ArrayBufferLike`\> \| `null` \| `undefined`
 
-`Uint8Array`\<`ArrayBufferLike`\> | `null` | `undefined`
+The bytes to convert to an object.
 
 #### Returns
 
@@ -88,7 +88,7 @@ GeneralError if there was an error parsing the JSON.
 
 ***
 
-### clone()
+### clone() {#clone}
 
 > `static` **clone**\<`T`\>(`obj`): `T`
 
@@ -116,7 +116,7 @@ The objects clone.
 
 ***
 
-### merge()
+### merge() {#merge}
 
 > `static` **merge**\<`T`, `U`\>(`obj1`, `obj2`): `T` & `U`
 
@@ -154,7 +154,7 @@ The combined deep merge of the objects.
 
 ***
 
-### equal()
+### equal() {#equal}
 
 > `static` **equal**\<`T`\>(`obj1`, `obj2`, `strictPropertyOrder?`): `boolean`
 
@@ -194,7 +194,7 @@ True is the objects are equal.
 
 ***
 
-### propertyGet()
+### propertyGet() {#propertyget}
 
 > `static` **propertyGet**\<`T`\>(`obj`, `property`): `T` \| `undefined`
 
@@ -228,7 +228,7 @@ The property.
 
 ***
 
-### propertySet()
+### propertySet() {#propertyset}
 
 > `static` **propertySet**(`obj`, `property`, `value`): `void`
 
@@ -264,7 +264,7 @@ GeneralError if the property target is not an object.
 
 ***
 
-### propertyDelete()
+### propertyDelete() {#propertydelete}
 
 > `static` **propertyDelete**(`obj`, `property`): `void`
 
@@ -276,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
 
@@ -290,9 +290,9 @@ The property to set
 
 ***
 
-### extractProperty()
+### extractProperty() {#extractproperty}
 
-> `static` **extractProperty**\<`T`\>(`obj`, `propertyNames`, `removeProperties`): `T` \| `undefined`
+> `static` **extractProperty**\<`T`\>(`obj`, `propertyNames`, `removeProperties?`): `T` \| `undefined`
 
 Extract a property from the object, providing alternative names.
 
@@ -312,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`
 
@@ -330,117 +330,179 @@ The property if available.
 
 ***
 
-### pick()
+### pick() {#pick}
+
+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`\>(`obj`, `keys?`): `Partial`\<`T`\>
+> `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.
 
-`T` | `undefined`
+###### 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
 
-##### keys?
+`K` *extends* `string` \| `number` \| `symbol`
 
-keyof `T`[]
+##### Parameters
+
+###### obj
+
+`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
+
+The property keys to omit.
+
+#### Call Signature
 
-> `static` **omit**\<`T`\>(`obj`, `keys?`): `Partial`\<`T`\>
+> `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
-
-##### obj
+###### K
 
-The object to omit the properties from.
+`K` *extends* `string` \| `number` \| `symbol`
 
-`T` | `undefined`
+##### Parameters
 
-##### keys?
+###### obj
 
-keyof `T`[]
+`T`
 
-The property keys to omit.
+The object to omit the properties from.
 
-#### Returns
+###### keys?
 
-`Partial`\<`T`\>
+`K`[]
 
-The partial object.
+The property keys to omit.
 
-***
+##### Returns
 
-### split()
+`Omit`\<`T`, `K`\>
 
-> `static` **split**\<`T`\>(`obj`, `keys?`): `object`
+The object without the omitted keys.
 
-Split an object into two with the specified keys.
+#### Call Signature
 
-#### Type Parameters
+> `static` **omit**\<`T`, `K`\>(`obj`, `keys?`): `Omit`\<`T`, `K`\> \| `undefined`
 
-##### T
+Omit a subset of properties from an object.
 
-`T`
+##### Type Parameters
 
-#### Parameters
+###### T
 
-##### obj
+`T`
 
-The object to split.
+###### K
 
-`T` | `undefined`
+`K` *extends* `string` \| `number` \| `symbol`
 
-##### keys?
+##### Parameters
 
-keyof `T`[]
+###### obj
 
-The property keys to split.
+`T` \| `undefined`
 
-#### Returns
+The object to omit the properties from.
 
-`object`
+###### keys?
 
-The two partial objects.
+`K`[]
 
-##### picked
+The property keys to omit.
 
-> **picked**: `Partial`\<`T`\> \| `undefined`
+##### Returns
 
-##### omitted
+`Omit`\<`T`, `K`\> \| `undefined`
 
-> **omitted**: `Partial`\<`T`\> \| `undefined`
+The object without the omitted keys, or undefined if the input was undefined.
 
 ***
 
-### toExtended()
+### toExtended() {#toextended}
 
 > `static` **toExtended**(`obj`): `any`
 
@@ -462,7 +524,7 @@ The object with extended properties.
 
 ***
 
-### fromExtended()
+### fromExtended() {#fromextended}
 
 > `static` **fromExtended**(`obj`): `any`
 
@@ -484,7 +546,7 @@ The object with regular properties.
 
 ***
 
-### removeEmptyProperties()
+### removeEmptyProperties() {#removeemptyproperties}
 
 > `static` **removeEmptyProperties**\<`T`\>(`obj`, `options?`): `T`