@twin.org/core 0.0.3-next.4 → 0.0.3-next.41

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`
 

package/docs/reference/classes/RandomHelper.md

@@ -12,9 +12,17 @@ Class to help with random generation.
 
 `RandomHelper`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### generate()
+### generate() {#generate}
 
 > `static` **generate**(`length`): `Uint8Array`
 
@@ -33,3 +41,47 @@ The length of buffer to create.
 `Uint8Array`
 
 The random array.
+
+***
+
+### generateUuidV7() {#generateuuidv7}
+
+> `static` **generateUuidV7**(`format?`): `string`
+
+Generate a new UUIDv7.
+
+#### Parameters
+
+##### format?
+
+`"standard"` \| `"compact"`
+
+The format of the UUIDv7 string.
+
+#### Returns
+
+`string`
+
+The UUIDv7 string.
+
+***
+
+### uuidV7ExtractTimestamp() {#uuidv7extracttimestamp}
+
+> `static` **uuidV7ExtractTimestamp**(`uuid`): `number`
+
+Extract the unix timestamp (ms) from a UUIDv7.
+
+#### Parameters
+
+##### uuid
+
+`string`
+
+The UUIDv7 string.
+
+#### Returns
+
+`number`
+
+The unix timestamp in milliseconds.

package/docs/reference/classes/SharedStore.md

@@ -15,7 +15,7 @@ instance loads of a packages.
 
 ## Methods
 
-### get()
+### get() {#get}
 
 > `static` **get**\<`T`\>(`prop`): `T` \| `undefined`
 
@@ -43,7 +43,7 @@ The property if it exists.
 
 ***
 
-### set()
+### set() {#set}
 
 > `static` **set**\<`T`\>(`prop`, `value`): `void`
 
@@ -75,7 +75,7 @@ The value to set.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > `static` **remove**(`prop`): `void`
 

package/docs/reference/classes/StringHelper.md

@@ -14,7 +14,7 @@ Class to help with string.
 
 ## Methods
 
-### trimTrailingSlashes()
+### trimTrailingSlashes() {#trimtrailingslashes}
 
 > `static` **trimTrailingSlashes**(`value`): `string`
 
@@ -36,7 +36,7 @@ The trimmed string or the original.
 
 ***
 
-### trimLeadingSlashes()
+### trimLeadingSlashes() {#trimleadingslashes}
 
 > `static` **trimLeadingSlashes**(`value`): `string`
 
@@ -58,9 +58,31 @@ The trimmed string or the original.
 
 ***
 
-### kebabCase()
+### trimLeadingAndTrailingSlashes() {#trimleadingandtrailingslashes}
 
-> `static` **kebabCase**(`input`, `stripInterfacePrefix`): `string`
+> `static` **trimLeadingAndTrailingSlashes**(`value`): `string`
+
+Trim both leading and trailing slashes from a string.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The value to trim.
+
+#### Returns
+
+`string`
+
+The trimmed string or the original.
+
+***
+
+### kebabCase() {#kebabcase}
+
+> `static` **kebabCase**(`input`, `stripInterfacePrefix?`): `string`
 
 Convert the input string to kebab case.
 
@@ -72,7 +94,7 @@ Convert the input string to kebab case.
 
 The input to convert.
 
-##### stripInterfacePrefix
+##### stripInterfacePrefix?
 
 `boolean` = `true`
 
@@ -86,9 +108,9 @@ The kebab case version of the input.
 
 ***
 
-### snakeCase()
+### snakeCase() {#snakecase}
 
-> `static` **snakeCase**(`input`, `stripInterfacePrefix`): `string`
+> `static` **snakeCase**(`input`, `stripInterfacePrefix?`): `string`
 
 Convert the input string to snake case.
 
@@ -100,7 +122,7 @@ Convert the input string to snake case.
 
 The input to convert.
 
-##### stripInterfacePrefix
+##### stripInterfacePrefix?
 
 `boolean` = `true`
 
@@ -114,9 +136,9 @@ The snake case version of the input.
 
 ***
 
-### titleCase()
+### titleCase() {#titlecase}
 
-> `static` **titleCase**(`input`, `stripInterfacePrefix`): `string`
+> `static` **titleCase**(`input`, `stripInterfacePrefix?`): `string`
 
 Title case all the words.
 
@@ -128,7 +150,7 @@ Title case all the words.
 
 The input to convert.
 
-##### stripInterfacePrefix
+##### stripInterfacePrefix?
 
 `boolean` = `true`
 
@@ -142,9 +164,9 @@ The title case version of the input.
 
 ***
 
-### pascalCase()
+### pascalCase() {#pascalcase}
 
-> `static` **pascalCase**(`input`, `stripInterfacePrefix`): `string`
+> `static` **pascalCase**(`input`, `stripInterfacePrefix?`): `string`
 
 Pascal case all the words.
 
@@ -156,7 +178,7 @@ Pascal case all the words.
 
 The input to convert.
 
-##### stripInterfacePrefix
+##### stripInterfacePrefix?
 
 `boolean` = `true`
 
@@ -170,9 +192,9 @@ The pascal case version of the input.
 
 ***
 
-### camelCase()
+### camelCase() {#camelcase}
 
-> `static` **camelCase**(`input`, `stripInterfacePrefix`): `string`
+> `static` **camelCase**(`input`, `stripInterfacePrefix?`): `string`
 
 Camel case all the words.
 
@@ -184,7 +206,7 @@ Camel case all the words.
 
 The input to convert.
 
-##### stripInterfacePrefix
+##### stripInterfacePrefix?
 
 `boolean` = `true`
 
@@ -198,9 +220,9 @@ The camel case version of the input.
 
 ***
 
-### wordPath()
+### wordPath() {#wordpath}
 
-> `static` **wordPath**(`input`, `stripInterfacePrefix`): `string`
+> `static` **wordPath**(`input`, `stripInterfacePrefix?`): `string`
 
 Convert the words to a path.
 
@@ -212,7 +234,7 @@ Convert the words to a path.
 
 The input to convert.
 
-##### stripInterfacePrefix
+##### stripInterfacePrefix?
 
 `boolean` = `true`
 
@@ -226,7 +248,7 @@ The path version of the input.
 
 ***
 
-### stripPrefix()
+### stripPrefix() {#stripprefix}
 
 > `static` **stripPrefix**(`input`): `string`
 
@@ -248,7 +270,7 @@ The input with any interface prefix stripped.
 
 ***
 
-### words()
+### words() {#words}
 
 > `static` **words**(`input`): `string`[]
 
@@ -270,7 +292,7 @@ The string split into words.
 
 ***
 
-### isUtf8()
+### isUtf8() {#isutf8}
 
 > `static` **isUtf8**(`data`): `boolean`
 

package/docs/reference/classes/Uint8ArrayHelper.md

@@ -14,7 +14,7 @@ Class to help with uint8 arrays.
 
 ## Methods
 
-### concat()
+### concat() {#concat}
 
 > `static` **concat**(`arrays`): `Uint8Array`