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

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.
 

package/docs/reference/classes/SharedStore.md

@@ -0,0 +1,94 @@
+# Class: SharedStore
+
+Provide a store for shared objects which can be accesses through multiple
+instance loads of a packages.
+
+## Constructors
+
+### Constructor
+
+> **new SharedStore**(): `SharedStore`
+
+#### Returns
+
+`SharedStore`
+
+## Methods
+
+### get()
+
+> `static` **get**\<`T`\>(`prop`): `undefined` \| `T`
+
+Get a property from the shared store.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### prop
+
+`string`
+
+The name of the property to get.
+
+#### Returns
+
+`undefined` \| `T`
+
+The property if it exists.
+
+***
+
+### set()
+
+> `static` **set**\<`T`\>(`prop`, `value`): `void`
+
+Set the property in the shared store.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### prop
+
+`string`
+
+The name of the property to set.
+
+##### value
+
+`T`
+
+The value to set.
+
+#### Returns
+
+`void`
+
+***
+
+### remove()
+
+> `static` **remove**(`prop`): `void`
+
+Remove a property from the shared store.
+
+#### Parameters
+
+##### prop
+
+`string`
+
+The name of the property to remove.
+
+#### Returns
+
+`void`

package/docs/reference/classes/StringHelper.md

@@ -4,13 +4,13 @@ Class to help with string.
 
 ## Constructors
 
-### new StringHelper()
+### Constructor
 
-> **new StringHelper**(): [`StringHelper`](StringHelper.md)
+> **new StringHelper**(): `StringHelper`
 
 #### Returns
 
-[`StringHelper`](StringHelper.md)
+`StringHelper`
 
 ## Methods
 
@@ -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.