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

package/docs/reference/classes/BitString.md

@@ -4,43 +4,49 @@ A class to represent a bit string.
 
 ## Constructors
 
-### new BitString()
+### Constructor
 
-> **new BitString**(`numberBits`): [`BitString`](BitString.md)
+> **new BitString**(`numberBits`): `BitString`
 
 Create a new instance of BitString.
 
 #### Parameters
 
-• **numberBits**: `number`
+##### numberBits
+
+`number`
 
 The length of the bit string.
 
 #### Returns
 
-[`BitString`](BitString.md)
+`BitString`
 
 ## Methods
 
 ### fromBits()
 
-> `static` **fromBits**(`bits`, `numberBits`): [`BitString`](BitString.md)
+> `static` **fromBits**(`bits`, `numberBits`): `BitString`
 
 Create a new instance of BitString from a bit array.
 
 #### Parameters
 
-• **bits**: `Uint8Array`
+##### bits
+
+`Uint8Array`
 
 The bits to create the bit string from.
 
-• **numberBits**: `number`
+##### numberBits
+
+`number`
 
 The number of bits in the bit string.
 
 #### Returns
 
-[`BitString`](BitString.md)
+`BitString`
 
 The new instance of BitString.
 
@@ -54,7 +60,9 @@ Get the bit at the given index.
 
 #### Parameters
 
-• **index**: `number`
+##### index
+
+`number`
 
 The index to get the bit for.
 
@@ -78,11 +86,15 @@ Set the bit at the given index.
 
 #### Parameters
 
-• **index**: `number`
+##### index
+
+`number`
 
 The index to set the bit for.
 
-• **value**: `boolean`
+##### value
+
+`boolean`
 
 The value to set the bit to.
 

package/docs/reference/classes/Coerce.md

@@ -4,13 +4,13 @@ Coerce an object from one type to another.
 
 ## Constructors
 
-### new Coerce()
+### Constructor
 
-> **new Coerce**(): [`Coerce`](Coerce.md)
+> **new Coerce**(): `Coerce`
 
 #### Returns
 
-[`Coerce`](Coerce.md)
+`Coerce`
 
 ## Methods
 
@@ -22,7 +22,9 @@ Coerce the value to a string.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to coerce.
 
@@ -46,7 +48,35 @@ Coerce the value to a number.
 
 #### Parameters
 
-• **value**: `unknown`
+##### 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.
+
+***
+
+### integer()
+
+> `static` **integer**(`value`): `undefined` \| `number`
+
+Coerce the value to an integer.
+
+#### Parameters
+
+##### value
+
+`unknown`
 
 The value to coerce.
 
@@ -70,7 +100,9 @@ Coerce the value to a bigint.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to coerce.
 
@@ -94,7 +126,9 @@ Coerce the value to a boolean.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to coerce.
 
@@ -118,7 +152,9 @@ Coerce the value to a date.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to coerce.
 
@@ -142,7 +178,9 @@ Coerce the value to a date/time.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to coerce.
 
@@ -166,7 +204,9 @@ Coerce the value to a time.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to coerce.
 
@@ -190,11 +230,15 @@ Coerce the value to an object.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to coerce.
 
@@ -207,3 +251,57 @@ The value if it can be coerced.
 #### Throws
 
 TypeError If the value can not be coerced.
+
+***
+
+### uint8Array()
+
+> `static` **uint8Array**(`value`): `undefined` \| `Uint8Array`\<`ArrayBufferLike`\>
+
+Coerce the value to a Uint8Array.
+
+#### Parameters
+
+##### value
+
+`unknown`
+
+The value to coerce.
+
+#### Returns
+
+`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>
+
+The value if it can be coerced.
+
+#### Throws
+
+TypeError If the value can not be coerced.
+
+***
+
+### byType()
+
+> `static` **byType**(`value`, `type?`): `unknown`
+
+Coerces a value based on the coercion type.
+
+#### Parameters
+
+##### value
+
+`unknown`
+
+The value to coerce.
+
+##### type?
+
+[`CoerceType`](../type-aliases/CoerceType.md)
+
+The coercion type to perform.
+
+#### Returns
+
+`unknown`
+
+The coerced value.

package/docs/reference/classes/Compression.md

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

package/docs/reference/classes/ConflictError.md

@@ -8,41 +8,51 @@ Class to handle errors which are triggered by conflicting data.
 
 ## Constructors
 
-### new ConflictError()
+### Constructor
 
-> **new ConflictError**(`source`, `message`, `conflictId`?, `conflicts`?, `inner`?): [`ConflictError`](ConflictError.md)
+> **new ConflictError**(`source`, `message`, `conflictId?`, `conflicts?`, `inner?`): `ConflictError`
 
 Create a new instance of ConflictError.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message as a code.
 
-• **conflictId?**: `string`
+##### conflictId?
+
+`string`
 
 The id that has conflicts.
 
-• **conflicts?**: `string`[]
+##### conflicts?
+
+`string`[]
 
 The conflicts that occurred.
 
-• **inner?**: `unknown`
+##### inner?
+
+`unknown`
 
 The inner error if we have wrapped another error.
 
 #### Returns
 
-[`ConflictError`](ConflictError.md)
+`ConflictError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -66,7 +76,7 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Inherited from
 
@@ -102,7 +112,9 @@ Construct an error from an existing one.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The existing error.
 
@@ -126,7 +138,9 @@ Flatten an error tree.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The starting error.
 
@@ -150,10 +164,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)
@@ -174,14 +190,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`
@@ -202,14 +222,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`
@@ -230,14 +254,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`
@@ -258,14 +286,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`
@@ -286,14 +318,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`
@@ -314,11 +350,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.
 
@@ -342,14 +382,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`
@@ -362,12 +406,46 @@ True if the error has the name.
 
 ***
 
+### isEmpty()
+
+> `static` **isEmpty**(`err`): `boolean`
+
+Is the error empty.
+
+#### Parameters
+
+##### err
+
+[`IError`](../interfaces/IError.md)
+
+The error to check for being empty.
+
+#### Returns
+
+`boolean`
+
+True if the error is empty.
+
+#### Inherited from
+
+[`BaseError`](BaseError.md).[`isEmpty`](BaseError.md#isempty)
+
+***
+
 ### toJsonObject()
 
-> **toJsonObject**(): [`IError`](../interfaces/IError.md)
+> **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 
 Serialize the error to the error model.
 
+#### Parameters
+
+##### includeStackTrace?
+
+`boolean`
+
+Whether to include the error stack in the model, defaults to false.
+
 #### Returns
 
 [`IError`](../interfaces/IError.md)