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

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.
 

package/docs/reference/classes/Uint8ArrayHelper.md

@@ -0,0 +1,35 @@
+# Class: Uint8ArrayHelper
+
+Class to help with uint8 arrays.
+
+## Constructors
+
+### Constructor
+
+> **new Uint8ArrayHelper**(): `Uint8ArrayHelper`
+
+#### Returns
+
+`Uint8ArrayHelper`
+
+## Methods
+
+### concat()
+
+> `static` **concat**(`arrays`): `Uint8Array`
+
+Concatenate multiple arrays.
+
+#### Parameters
+
+##### arrays
+
+`Uint8Array`\<`ArrayBufferLike`\>[]
+
+The array to concatenate.
+
+#### Returns
+
+`Uint8Array`
+
+The combined array.

package/docs/reference/classes/UnauthorizedError.md

@@ -8,33 +8,39 @@ Class to handle errors which are triggered by access not being unauthorized.
 
 ## Constructors
 
-### new UnauthorizedError()
+### Constructor
 
-> **new UnauthorizedError**(`source`, `message`, `inner`?): [`UnauthorizedError`](UnauthorizedError.md)
+> **new UnauthorizedError**(`source`, `message`, `inner?`): `UnauthorizedError`
 
 Create a new instance of UnauthorizedError.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message as a code.
 
-• **inner?**: `unknown`
+##### inner?
+
+`unknown`
 
 The inner error if we have wrapped another error.
 
 #### Returns
 
-[`UnauthorizedError`](UnauthorizedError.md)
+`UnauthorizedError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -58,7 +64,7 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Inherited from
 
@@ -94,7 +100,9 @@ Construct an error from an existing one.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The existing error.
 
@@ -118,7 +126,9 @@ Flatten an error tree.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The starting error.
 
@@ -142,10 +152,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)
@@ -166,14 +178,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`
@@ -194,14 +210,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`
@@ -222,14 +242,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`
@@ -250,14 +274,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`
@@ -278,14 +306,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`
@@ -306,11 +338,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.
 
@@ -334,14 +370,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`
@@ -354,12 +394,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)