@twin.org/core 0.0.1-next.5 → 0.0.1-next.51

package/docs/reference/classes/AlreadyExistsError.md

@@ -16,19 +16,27 @@ Create a new instance of AlreadyExistsError.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message as a code.
 
-• **existingId?**: `string`
+##### existingId?
+
+`string`
 
 The id for the item.
 
-• **inner?**: `unknown`
+##### inner?
+
+`unknown`
 
 The inner error if we have wrapped another error.
 
@@ -58,7 +66,7 @@ The source of the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source-1)
 
 ***
 
@@ -70,11 +78,11 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties)
+[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties-1)
 
 ***
 
@@ -86,7 +94,7 @@ The inner error if there was one.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
+[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner-1)
 
 ## Methods
 
@@ -98,7 +106,9 @@ Construct an error from an existing one.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The existing error.
 
@@ -122,7 +132,9 @@ Flatten an error tree.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The starting error.
 
@@ -146,10 +158,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)
@@ -170,14 +184,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`
@@ -198,14 +216,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`
@@ -226,14 +248,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`
@@ -254,14 +280,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`
@@ -282,14 +312,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`
@@ -310,11 +344,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.
 
@@ -338,14 +376,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`

package/docs/reference/classes/ArrayHelper.md

@@ -22,11 +22,15 @@ Do the two arrays match.
 
 #### Parameters
 
-• **arr1**: `unknown`
+##### arr1
+
+`unknown`
 
 The first array.
 
-• **arr2**: `unknown`
+##### arr2
+
+`unknown`
 
 The second array.
 

package/docs/reference/classes/AsyncCache.md

@@ -26,15 +26,21 @@ Execute an async request and cache the result.
 
 #### Parameters
 
-• **key**: `string`
+##### key
+
+`string`
 
 The key for the entry in the cache.
 
-• **ttlMs**: `undefined` \| `number`
+##### ttlMs
 
 The TTL of the entry in the cache.
 
-• **requestMethod**
+`undefined` | `number`
+
+##### requestMethod
+
+() => `Promise`\<`T`\>
 
 The method to call if not cached.
 
@@ -58,7 +64,9 @@ Get an entry from the cache.
 
 #### Parameters
 
-• **key**: `string`
+##### key
+
+`string`
 
 The key to get from the cache.
 
@@ -70,6 +78,44 @@ The item from the cache if it exists.
 
 ***
 
+### set()
+
+> `static` **set**\<`T`\>(`key`, `value`, `ttlMs`?): `Promise`\<`void`\>
+
+Set an entry into the cache.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+##### key
+
+`string`
+
+The key to set in the cache.
+
+##### value
+
+`T`
+
+The value to set in the cache.
+
+##### ttlMs?
+
+`number`
+
+The TTL of the entry in the cache in ms, defaults to 1s.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
 ### remove()
 
 > `static` **remove**(`key`): `void`
@@ -78,7 +124,9 @@ Remove an entry from the cache.
 
 #### Parameters
 
-• **key**: `string`
+##### key
+
+`string`
 
 The key to remove from the cache.
 
@@ -96,7 +144,9 @@ Clear the cache.
 
 #### Parameters
 
-• **prefix?**: `string`
+##### prefix?
+
+`string`
 
 Optional prefix to clear only entries with that prefix.
 

package/docs/reference/classes/Base32.md

@@ -22,7 +22,9 @@ Convert the base 32 string to a byte array.
 
 #### Parameters
 
-• **base32**: `string`
+##### base32
+
+`string`
 
 The base32 string to convert.
 
@@ -46,7 +48,9 @@ Convert a byte array to base 32.
 
 #### Parameters
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The byte array to convert.
 

package/docs/reference/classes/Base58.md

@@ -0,0 +1,61 @@
+# Class: Base58
+
+Class to help with base58 Encoding/Decoding.
+
+## Constructors
+
+### new Base58()
+
+> **new Base58**(): [`Base58`](Base58.md)
+
+#### Returns
+
+[`Base58`](Base58.md)
+
+## Methods
+
+### decode()
+
+> `static` **decode**(`base58`): `Uint8Array`
+
+Convert the base 58 string to a byte array.
+
+#### Parameters
+
+##### base58
+
+`string`
+
+The base58 string to convert.
+
+#### Returns
+
+`Uint8Array`
+
+The byte array.
+
+#### Throws
+
+If the input string contains a character not in the Base58 alphabet.
+
+***
+
+### encode()
+
+> `static` **encode**(`bytes`): `string`
+
+Convert a byte array to base 58.
+
+#### Parameters
+
+##### bytes
+
+`Uint8Array`
+
+The byte array to encode.
+
+#### Returns
+
+`string`
+
+The data as base58 string.

package/docs/reference/classes/Base64.md

@@ -23,7 +23,9 @@ Get the byte length of the data.
 
 #### Parameters
 
-• **base64**: `string`
+##### base64
+
+`string`
 
 The base64 string.
 
@@ -43,7 +45,9 @@ Convert the base 64 string to a byte array.
 
 #### Parameters
 
-• **base64**: `string`
+##### base64
+
+`string`
 
 The base64 string to convert.
 
@@ -63,7 +67,9 @@ Convert a byte array to base 64.
 
 #### Parameters
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The byte array to convert.
 

package/docs/reference/classes/Base64Url.md

@@ -23,7 +23,9 @@ Convert the base 64 string to a byte array.
 
 #### Parameters
 
-• **base64Url**: `string`
+##### base64Url
+
+`string`
 
 The base64 url string to convert.
 
@@ -43,7 +45,9 @@ Convert a byte array to base 64 url.
 
 #### Parameters
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The byte array to convert.
 

package/docs/reference/classes/BaseError.md

@@ -33,23 +33,31 @@ Create a new instance of BaseError.
 
 #### Parameters
 
-• **name**: `string`
+##### name
+
+`string`
 
 The name of the error.
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message as a code.
 
-• **properties?**
+##### properties?
 
 Any additional information for the error.
 
-• **inner?**: `unknown`
+##### inner?
+
+`unknown`
 
 The inner error if we have wrapped another error.
 
@@ -83,7 +91,7 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Implementation of
 
@@ -111,7 +119,9 @@ Construct an error from an existing one.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The existing error.
 
@@ -131,7 +141,9 @@ Flatten an error tree.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The starting error.
 
@@ -151,10 +163,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)
@@ -171,14 +185,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`
@@ -195,14 +213,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`
@@ -219,14 +241,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`
@@ -243,14 +269,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`
@@ -267,14 +297,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`
@@ -291,11 +325,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.
 
@@ -315,14 +353,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`