@twin.org/core 0.0.1-next.1

package/docs/reference/classes/BitString.md

@@ -0,0 +1,123 @@
+# Class: BitString
+
+A class to represent a bit string.
+
+## Constructors
+
+### new BitString()
+
+> **new BitString**(`numberBits`): [`BitString`](BitString.md)
+
+Create a new instance of BitString.
+
+#### Parameters
+
+• **numberBits**: `number`
+
+The length of the bit string.
+
+#### Returns
+
+[`BitString`](BitString.md)
+
+## Methods
+
+### fromBits()
+
+> `static` **fromBits**(`bits`, `numberBits`): [`BitString`](BitString.md)
+
+Create a new instance of BitString from a bit array.
+
+#### Parameters
+
+• **bits**: `Uint8Array`
+
+The bits to create the bit string from.
+
+• **numberBits**: `number`
+
+The number of bits in the bit string.
+
+#### Returns
+
+[`BitString`](BitString.md)
+
+The new instance of BitString.
+
+***
+
+### getBit()
+
+> **getBit**(`index`): `boolean`
+
+Get the bit at the given index.
+
+#### Parameters
+
+• **index**: `number`
+
+The index to get the bit for.
+
+#### Returns
+
+`boolean`
+
+True if the bit at the index is set.
+
+#### Throws
+
+GeneralError if the index is out of range.
+
+***
+
+### setBit()
+
+> **setBit**(`index`, `value`): `void`
+
+Set the bit at the given index.
+
+#### Parameters
+
+• **index**: `number`
+
+The index to set the bit for.
+
+• **value**: `boolean`
+
+The value to set the bit to.
+
+#### Returns
+
+`void`
+
+#### Throws
+
+GeneralError if the index is out of range.
+
+***
+
+### getBits()
+
+> **getBits**(): `Uint8Array`
+
+Get the bits of the bit string.
+
+#### Returns
+
+`Uint8Array`
+
+The bits stored in a Uint8Array.
+
+***
+
+### getLength()
+
+> **getLength**(): `number`
+
+Get the length of the bit string.
+
+#### Returns
+
+`number`
+
+The length of the bit string.

package/docs/reference/classes/Coerce.md

@@ -0,0 +1,209 @@
+# Class: Coerce
+
+Coerce an object from one type to another.
+
+## Constructors
+
+### new Coerce()
+
+> **new Coerce**(): [`Coerce`](Coerce.md)
+
+#### Returns
+
+[`Coerce`](Coerce.md)
+
+## Methods
+
+### string()
+
+> `static` **string**(`value`): `undefined` \| `string`
+
+Coerce the value to a string.
+
+#### Parameters
+
+• **value**: `unknown`
+
+The value to coerce.
+
+#### Returns
+
+`undefined` \| `string`
+
+The value if it can be coerced.
+
+#### Throws
+
+TypeError If the value can not be coerced.
+
+***
+
+### number()
+
+> `static` **number**(`value`): `undefined` \| `number`
+
+Coerce the value to a number.
+
+#### Parameters
+
+• **value**: `unknown`
+
+The value to coerce.
+
+#### Returns
+
+`undefined` \| `number`
+
+The value if it can be coerced.
+
+#### Throws
+
+TypeError If the value can not be coerced.
+
+***
+
+### bigint()
+
+> `static` **bigint**(`value`): `undefined` \| `bigint`
+
+Coerce the value to a bigint.
+
+#### Parameters
+
+• **value**: `unknown`
+
+The value to coerce.
+
+#### Returns
+
+`undefined` \| `bigint`
+
+The value if it can be coerced.
+
+#### Throws
+
+TypeError If the value can not be coerced.
+
+***
+
+### boolean()
+
+> `static` **boolean**(`value`): `undefined` \| `boolean`
+
+Coerce the value to a boolean.
+
+#### Parameters
+
+• **value**: `unknown`
+
+The value to coerce.
+
+#### Returns
+
+`undefined` \| `boolean`
+
+The value if it can be coerced.
+
+#### Throws
+
+TypeError If the value can not be coerced.
+
+***
+
+### date()
+
+> `static` **date**(`value`): `undefined` \| `Date`
+
+Coerce the value to a date.
+
+#### Parameters
+
+• **value**: `unknown`
+
+The value to coerce.
+
+#### Returns
+
+`undefined` \| `Date`
+
+The value if it can be coerced.
+
+#### Throws
+
+TypeError If the value can not be coerced.
+
+***
+
+### dateTime()
+
+> `static` **dateTime**(`value`): `undefined` \| `Date`
+
+Coerce the value to a date/time.
+
+#### Parameters
+
+• **value**: `unknown`
+
+The value to coerce.
+
+#### Returns
+
+`undefined` \| `Date`
+
+The value if it can be coerced.
+
+#### Throws
+
+TypeError If the value can not be coerced.
+
+***
+
+### time()
+
+> `static` **time**(`value`): `undefined` \| `Date`
+
+Coerce the value to a time.
+
+#### Parameters
+
+• **value**: `unknown`
+
+The value to coerce.
+
+#### Returns
+
+`undefined` \| `Date`
+
+The value if it can be coerced.
+
+#### Throws
+
+TypeError If the value can not be coerced.
+
+***
+
+### object()
+
+> `static` **object**\<`T`\>(`value`): `undefined` \| `T`
+
+Coerce the value to an object.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **value**: `unknown`
+
+The value to coerce.
+
+#### Returns
+
+`undefined` \| `T`
+
+The value if it can be coerced.
+
+#### Throws
+
+TypeError If the value can not be coerced.

package/docs/reference/classes/Compression.md

@@ -0,0 +1,61 @@
+# Class: Compression
+
+A class to handle compression.
+
+## Constructors
+
+### new Compression()
+
+> **new Compression**(): [`Compression`](Compression.md)
+
+#### Returns
+
+[`Compression`](Compression.md)
+
+## Methods
+
+### compress()
+
+> `static` **compress**(`bytes`, `type`): `Promise`\<`Uint8Array`\>
+
+Compress bytes using GZIP.
+
+#### Parameters
+
+• **bytes**: `Uint8Array`
+
+The bytes to compress.
+
+• **type**: [`CompressionType`](../type-aliases/CompressionType.md)
+
+The type of compression to use.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\>
+
+The compressed bytes.
+
+***
+
+### decompress()
+
+> `static` **decompress**(`compressedBytes`, `type`): `Promise`\<`Uint8Array`\>
+
+Decompress a gzipped compressed byte array.
+
+#### Parameters
+
+• **compressedBytes**: `Uint8Array`
+
+The compressed bytes.
+
+• **type**: [`CompressionType`](../type-aliases/CompressionType.md)
+
+The type of compression to use.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\>
+
+The decompressed bytes.