@twin.org/core 0.0.1-next.5 → 0.0.1-next.51

package/docs/reference/classes/NotSupportedError.md

@@ -16,15 +16,21 @@ 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.
 
@@ -46,7 +52,7 @@ The source of the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source-1)
 
 ***
 
@@ -58,11 +64,11 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties)
+[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties-1)
 
 ***
 
@@ -74,7 +80,7 @@ The inner error if there was one.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
+[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner-1)
 
 ***
 
@@ -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`

package/docs/reference/classes/ObjectHelper.md

@@ -26,11 +26,15 @@ Convert an object to bytes.
 
 #### Parameters
 
-• **obj**: `undefined` \| `T`
+##### obj
 
 The object to convert.
 
-• **format**: `boolean` = `false`
+`undefined` | `T`
+
+##### format
+
+`boolean` = `false`
 
 Format the JSON content.
 
@@ -54,10 +58,12 @@ Convert a bytes to an object.
 
 #### Parameters
 
-• **bytes**: `undefined` \| `null` \| `Uint8Array`
+##### bytes
 
 The bytes to convert to an object.
 
+`undefined` | `null` | `Uint8Array`\<`ArrayBufferLike`\>
+
 #### Returns
 
 `T`
@@ -82,7 +88,9 @@ Make a deep clone of an object.
 
 #### Parameters
 
-• **obj**: `T`
+##### obj
+
+`T`
 
 The object to clone.
 
@@ -108,11 +116,15 @@ Deep merge objects.
 
 #### Parameters
 
-• **obj1**: `T`
+##### obj1
+
+`T`
 
 The first object to merge.
 
-• **obj2**: `U`
+##### obj2
+
+`U`
 
 The second object to merge.
 
@@ -136,15 +148,21 @@ Does one object equal another.
 
 #### 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.
 
@@ -168,11 +186,15 @@ Get the property of an unknown object.
 
 #### 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 +214,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 +236,10 @@ The value to set.
 
 `void`
 
+#### Throws
+
+GeneralError if the property target is not an object.
+
 ***
 
 ### propertyDelete()
@@ -218,11 +250,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
 
@@ -232,6 +268,44 @@ The property to set
 
 ***
 
+### extractProperty()
+
+> `static` **extractProperty**\<`T`\>(`obj`, `propertyNames`, `removeProperties`): `undefined` \| `T`
+
+Extract a property from the object, providing alternative names.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+##### obj
+
+`unknown`
+
+The object to extract from.
+
+##### propertyNames
+
+The possible names for the property.
+
+`string` | `string`[]
+
+##### removeProperties
+
+`boolean` = `true`
+
+Remove the properties from the object, defaults to true.
+
+#### Returns
+
+`undefined` \| `T`
+
+The property if available.
+
+***
+
 ### pick()
 
 > `static` **pick**\<`T`\>(`obj`, `keys`?): `Partial`\<`T`\>
@@ -244,11 +318,15 @@ Pick a subset of properties from an object.
 
 #### 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.
 
@@ -272,11 +350,15 @@ Omit a subset of properties from an object.
 
 #### 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.
 
@@ -285,3 +367,89 @@ 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** = `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

@@ -22,7 +22,9 @@ Generate a new random array.
 
 #### Parameters
 
-• **length**: `number`
+##### length
+
+`number`
 
 The length of buffer to create.
 

package/docs/reference/classes/StringHelper.md

@@ -22,10 +22,12 @@ Trim trailing slashes from a string.
 
 #### Parameters
 
-• **value**: `undefined` \| `string`
+##### value
 
 The value to trim.
 
+`undefined` | `string`
+
 #### Returns
 
 `string`
@@ -42,10 +44,12 @@ Trim leading slashes from a string.
 
 #### Parameters
 
-• **value**: `undefined` \| `string`
+##### value
 
 The value to trim.
 
+`undefined` | `string`
+
 #### Returns
 
 `string`
@@ -62,11 +66,15 @@ Convert the input string to kebab case.
 
 #### Parameters
 
-• **input**: `string`
+##### input
+
+`string`
 
 The input to convert.
 
-• **stripInterfacePrefix**: `boolean` = `true`
+##### stripInterfacePrefix
+
+`boolean` = `true`
 
 Strip interface prefixes.
 
@@ -86,11 +94,15 @@ Convert the input string to snake case.
 
 #### Parameters
 
-• **input**: `string`
+##### input
+
+`string`
 
 The input to convert.
 
-• **stripInterfacePrefix**: `boolean` = `true`
+##### stripInterfacePrefix
+
+`boolean` = `true`
 
 Strip interface prefixes.
 
@@ -110,11 +122,15 @@ Title case all the words.
 
 #### Parameters
 
-• **input**: `string`
+##### input
+
+`string`
 
 The input to convert.
 
-• **stripInterfacePrefix**: `boolean` = `true`
+##### stripInterfacePrefix
+
+`boolean` = `true`
 
 Strip interface prefixes.
 
@@ -134,11 +150,15 @@ Pascal case all the words.
 
 #### Parameters
 
-• **input**: `string`
+##### input
+
+`string`
 
 The input to convert.
 
-• **stripInterfacePrefix**: `boolean` = `true`
+##### stripInterfacePrefix
+
+`boolean` = `true`
 
 Strip interface prefixes.
 
@@ -158,11 +178,15 @@ Camel case all the words.
 
 #### Parameters
 
-• **input**: `string`
+##### input
+
+`string`
 
 The input to convert.
 
-• **stripInterfacePrefix**: `boolean` = `true`
+##### stripInterfacePrefix
+
+`boolean` = `true`
 
 Strip interface prefixes.
 
@@ -182,11 +206,15 @@ Convert the words to a path.
 
 #### Parameters
 
-• **input**: `string`
+##### input
+
+`string`
 
 The input to convert.
 
-• **stripInterfacePrefix**: `boolean` = `true`
+##### stripInterfacePrefix
+
+`boolean` = `true`
 
 Strip interface prefixes.
 
@@ -206,7 +234,9 @@ Strip interface prefix if there is one.
 
 #### Parameters
 
-• **input**: `string`
+##### input
+
+`string`
 
 The input to strip.
 
@@ -226,7 +256,9 @@ Split a string into words.
 
 #### Parameters
 
-• **input**: `string`
+##### input
+
+`string`
 
 The input to split.
 
@@ -259,7 +291,9 @@ UTF8-tail = %x80-BF.
 
 #### Parameters
 
-• **data**: `Uint8Array`
+##### data
+
+`Uint8Array`
 
 The data to check.