@twin.org/core 0.0.1-next.1

package/docs/reference/classes/ObjectHelper.md

@@ -0,0 +1,287 @@
+# Class: ObjectHelper
+
+Class to help with objects.
+
+## Constructors
+
+### new ObjectHelper()
+
+> **new ObjectHelper**(): [`ObjectHelper`](ObjectHelper.md)
+
+#### Returns
+
+[`ObjectHelper`](ObjectHelper.md)
+
+## Methods
+
+### toBytes()
+
+> `static` **toBytes**\<`T`\>(`obj`, `format`): `Uint8Array`
+
+Convert an object to bytes.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **obj**: `undefined` \| `T`
+
+The object to convert.
+
+• **format**: `boolean` = `false`
+
+Format the JSON content.
+
+#### Returns
+
+`Uint8Array`
+
+The object as bytes.
+
+***
+
+### fromBytes()
+
+> `static` **fromBytes**\<`T`\>(`bytes`): `T`
+
+Convert a bytes to an object.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **bytes**: `undefined` \| `null` \| `Uint8Array`
+
+The bytes to convert to an object.
+
+#### Returns
+
+`T`
+
+The object.
+
+#### Throws
+
+GeneralError if there was an error parsing the JSON.
+
+***
+
+### clone()
+
+> `static` **clone**\<`T`\>(`obj`): `T`
+
+Make a deep clone of an object.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **obj**: `T`
+
+The object to clone.
+
+#### Returns
+
+`T`
+
+The objects clone.
+
+***
+
+### merge()
+
+> `static` **merge**\<`T`, `U`\>(`obj1`, `obj2`): `T` & `U`
+
+Deep merge objects.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+• **U** = `unknown`
+
+#### Parameters
+
+• **obj1**: `T`
+
+The first object to merge.
+
+• **obj2**: `U`
+
+The second object to merge.
+
+#### Returns
+
+`T` & `U`
+
+The combined deep merge of the objects.
+
+***
+
+### equal()
+
+> `static` **equal**\<`T`\>(`obj1`, `obj2`, `strictPropertyOrder`?): `boolean`
+
+Does one object equal another.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **obj1**: `T`
+
+The first object to compare.
+
+• **obj2**: `T`
+
+The second object to compare.
+
+• **strictPropertyOrder?**: `boolean`
+
+Should the properties be in the same order, defaults to true.
+
+#### Returns
+
+`boolean`
+
+True is the objects are equal.
+
+***
+
+### propertyGet()
+
+> `static` **propertyGet**\<`T`\>(`obj`, `property`): `undefined` \| `T`
+
+Get the property of an unknown object.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **obj**: `unknown`
+
+The object to get the property from.
+
+• **property**: `string`
+
+The property to get, can be separated by dots for nested path.
+
+#### Returns
+
+`undefined` \| `T`
+
+The property.
+
+***
+
+### propertySet()
+
+> `static` **propertySet**(`obj`, `property`, `value`): `void`
+
+Set the property of an unknown object.
+
+#### Parameters
+
+• **obj**: `unknown`
+
+The object to set the property from.
+
+• **property**: `string`
+
+The property to set.
+
+• **value**: `unknown`
+
+The value to set.
+
+#### Returns
+
+`void`
+
+***
+
+### propertyDelete()
+
+> `static` **propertyDelete**(`obj`, `property`): `void`
+
+Delete the property of an unknown object.
+
+#### Parameters
+
+• **obj**: `unknown`
+
+The object to set the property from.
+
+• **property**: `string`
+
+The property to set
+
+#### Returns
+
+`void`
+
+***
+
+### pick()
+
+> `static` **pick**\<`T`\>(`obj`, `keys`?): `Partial`\<`T`\>
+
+Pick a subset of properties from an object.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **obj**: `undefined` \| `T`
+
+The object to pick the properties from.
+
+• **keys?**: keyof `T`[]
+
+The property keys to pick.
+
+#### Returns
+
+`Partial`\<`T`\>
+
+The partial object.
+
+***
+
+### omit()
+
+> `static` **omit**\<`T`\>(`obj`, `keys`?): `Partial`\<`T`\>
+
+Omit a subset of properties from an object.
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+• **obj**: `undefined` \| `T`
+
+The object to omit the properties from.
+
+• **keys?**: keyof `T`[]
+
+The property keys to omit.
+
+#### Returns
+
+`Partial`\<`T`\>
+
+The partial object.

package/docs/reference/classes/RandomHelper.md

@@ -0,0 +1,33 @@
+# Class: RandomHelper
+
+Class to help with random generation.
+
+## Constructors
+
+### new RandomHelper()
+
+> **new RandomHelper**(): [`RandomHelper`](RandomHelper.md)
+
+#### Returns
+
+[`RandomHelper`](RandomHelper.md)
+
+## Methods
+
+### generate()
+
+> `static` **generate**(`length`): `Uint8Array`
+
+Generate a new random array.
+
+#### Parameters
+
+• **length**: `number`
+
+The length of buffer to create.
+
+#### Returns
+
+`Uint8Array`
+
+The random array.

package/docs/reference/classes/StringHelper.md

@@ -0,0 +1,270 @@
+# Class: StringHelper
+
+Class to help with string.
+
+## Constructors
+
+### new StringHelper()
+
+> **new StringHelper**(): [`StringHelper`](StringHelper.md)
+
+#### Returns
+
+[`StringHelper`](StringHelper.md)
+
+## Methods
+
+### trimTrailingSlashes()
+
+> `static` **trimTrailingSlashes**(`value`): `string`
+
+Trim trailing slashes from a string.
+
+#### Parameters
+
+• **value**: `undefined` \| `string`
+
+The value to trim.
+
+#### Returns
+
+`string`
+
+The trimmed value.
+
+***
+
+### trimLeadingSlashes()
+
+> `static` **trimLeadingSlashes**(`value`): `string`
+
+Trim leading slashes from a string.
+
+#### Parameters
+
+• **value**: `undefined` \| `string`
+
+The value to trim.
+
+#### Returns
+
+`string`
+
+The trimmed value.
+
+***
+
+### kebabCase()
+
+> `static` **kebabCase**(`input`, `stripInterfacePrefix`): `string`
+
+Convert the input string to kebab case.
+
+#### Parameters
+
+• **input**: `string`
+
+The input to convert.
+
+• **stripInterfacePrefix**: `boolean` = `true`
+
+Strip interface prefixes.
+
+#### Returns
+
+`string`
+
+The kebab case version of the input.
+
+***
+
+### snakeCase()
+
+> `static` **snakeCase**(`input`, `stripInterfacePrefix`): `string`
+
+Convert the input string to snake case.
+
+#### Parameters
+
+• **input**: `string`
+
+The input to convert.
+
+• **stripInterfacePrefix**: `boolean` = `true`
+
+Strip interface prefixes.
+
+#### Returns
+
+`string`
+
+The snake case version of the input.
+
+***
+
+### titleCase()
+
+> `static` **titleCase**(`input`, `stripInterfacePrefix`): `string`
+
+Title case all the words.
+
+#### Parameters
+
+• **input**: `string`
+
+The input to convert.
+
+• **stripInterfacePrefix**: `boolean` = `true`
+
+Strip interface prefixes.
+
+#### Returns
+
+`string`
+
+The title case version of the input.
+
+***
+
+### pascalCase()
+
+> `static` **pascalCase**(`input`, `stripInterfacePrefix`): `string`
+
+Pascal case all the words.
+
+#### Parameters
+
+• **input**: `string`
+
+The input to convert.
+
+• **stripInterfacePrefix**: `boolean` = `true`
+
+Strip interface prefixes.
+
+#### Returns
+
+`string`
+
+The pascal case version of the input.
+
+***
+
+### camelCase()
+
+> `static` **camelCase**(`input`, `stripInterfacePrefix`): `string`
+
+Camel case all the words.
+
+#### Parameters
+
+• **input**: `string`
+
+The input to convert.
+
+• **stripInterfacePrefix**: `boolean` = `true`
+
+Strip interface prefixes.
+
+#### Returns
+
+`string`
+
+The camel case version of the input.
+
+***
+
+### wordPath()
+
+> `static` **wordPath**(`input`, `stripInterfacePrefix`): `string`
+
+Convert the words to a path.
+
+#### Parameters
+
+• **input**: `string`
+
+The input to convert.
+
+• **stripInterfacePrefix**: `boolean` = `true`
+
+Strip interface prefixes.
+
+#### Returns
+
+`string`
+
+The path version of the input.
+
+***
+
+### stripPrefix()
+
+> `static` **stripPrefix**(`input`): `string`
+
+Strip interface prefix if there is one.
+
+#### Parameters
+
+• **input**: `string`
+
+The input to strip.
+
+#### Returns
+
+`string`
+
+The input with any interface prefix stripped.
+
+***
+
+### words()
+
+> `static` **words**(`input`): `string`[]
+
+Split a string into words.
+
+#### Parameters
+
+• **input**: `string`
+
+The input to split.
+
+#### Returns
+
+`string`[]
+
+The string split into words.
+
+***
+
+### isUtf8()
+
+> `static` **isUtf8**(`data`): `boolean`
+
+Check if a Node.js Buffer or Uint8Array is UTF-8.
+Url https://tools.ietf.org/html/rfc3629
+Source https://github.com/hcodes/isutf8
+UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4.
+UTF8-1    = %x00-7F.
+UTF8-2    = %xC2-DF UTF8-tail.
+UTF8-3    = %xE0 %xA0-BF UTF8-tail.
+-           %xE1-EC 2( UTF8-tail ).
+-           %xED %x80-9F UTF8-tail.
+-           %xEE-EF 2( UTF8-tail ).
+UTF8-4    = %xF0 %x90-BF 2( UTF8-tail ).
+-           %xF1-F3 3( UTF8-tail ).
+-           %xF4 %x80-8F 2( UTF8-tail ).
+UTF8-tail = %x80-BF.
+
+#### Parameters
+
+• **data**: `Uint8Array`
+
+The data to check.
+
+#### Returns
+
+`boolean`
+
+True if the data is utf8.