@twin.org/core 0.0.2-next.8 → 0.0.2

package/docs/reference/classes/AsyncCache.md

@@ -14,9 +14,9 @@ Cache the results from asynchronous requests.
 
 ## Methods
 
-### exec()
+### exec() {#exec}
 
-> `static` **exec**\<`T`\>(`key`, `ttlMs`, `requestMethod`, `cacheFailures?`): `undefined` \| `Promise`\<`T`\>
+> `static` **exec**\<`T`\>(`key`, `ttlMs`, `requestMethod`, `cacheFailures?`): `Promise`\<`T`\> \| `undefined`
 
 Execute an async request and cache the result.
 
@@ -36,9 +36,9 @@ The key for the entry in the cache.
 
 ##### ttlMs
 
-The TTL of the entry in the cache.
+`number` \| `undefined`
 
-`undefined` | `number`
+The TTL of the entry in the cache.
 
 ##### requestMethod
 
@@ -54,15 +54,15 @@ Cache failure results, defaults to false.
 
 #### Returns
 
-`undefined` \| `Promise`\<`T`\>
+`Promise`\<`T`\> \| `undefined`
 
 The response.
 
 ***
 
-### get()
+### get() {#get}
 
-> `static` **get**\<`T`\>(`key`): `Promise`\<`undefined` \| `T`\>
+> `static` **get**\<`T`\>(`key`): `Promise`\<`T` \| `undefined`\>
 
 Get an entry from the cache.
 
@@ -82,13 +82,13 @@ The key to get from the cache.
 
 #### Returns
 
-`Promise`\<`undefined` \| `T`\>
+`Promise`\<`T` \| `undefined`\>
 
 The item from the cache if it exists.
 
 ***
 
-### set()
+### set() {#set}
 
 > `static` **set**\<`T`\>(`key`, `value`, `ttlMs?`): `Promise`\<`void`\>
 
@@ -128,7 +128,7 @@ Nothing.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > `static` **remove**(`key`): `void`
 
@@ -148,7 +148,7 @@ The key to remove from the cache.
 
 ***
 
-### clearCache()
+### clearCache() {#clearcache}
 
 > `static` **clearCache**(`prefix?`): `void`
 
@@ -168,7 +168,7 @@ Optional prefix to clear only entries with that prefix.
 
 ***
 
-### cleanupExpired()
+### cleanupExpired() {#cleanupexpired}
 
 > `static` **cleanupExpired**(): `void`
 

package/docs/reference/classes/Base32.md

@@ -1,6 +1,6 @@
 # Class: Base32
 
-Class to help with base63 Encoding/Decoding.
+Class to help with base32 Encoding/Decoding.
 
 ## Constructors
 
@@ -12,9 +12,17 @@ Class to help with base63 Encoding/Decoding.
 
 `Base32`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### decode()
+### decode() {#decode}
 
 > `static` **decode**(`base32`): `Uint8Array`
 
@@ -40,7 +48,7 @@ If the input string contains a character not in the Base32 alphabet.
 
 ***
 
-### encode()
+### encode() {#encode}
 
 > `static` **encode**(`bytes`): `string`
 

package/docs/reference/classes/Base58.md

@@ -12,9 +12,17 @@ Class to help with base58 Encoding/Decoding.
 
 `Base58`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### decode()
+### decode() {#decode}
 
 > `static` **decode**(`base58`): `Uint8Array`
 
@@ -40,7 +48,7 @@ If the input string contains a character not in the Base58 alphabet.
 
 ***
 
-### encode()
+### encode() {#encode}
 
 > `static` **encode**(`bytes`): `string`
 

package/docs/reference/classes/Base64.md

@@ -13,9 +13,17 @@ Sourced from https://github.com/beatgammit/base64-js.
 
 `Base64`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### byteLength()
+### byteLength() {#bytelength}
 
 > `static` **byteLength**(`base64`): `number`
 
@@ -37,7 +45,7 @@ The byte length of the data.
 
 ***
 
-### decode()
+### decode() {#decode}
 
 > `static` **decode**(`base64`): `Uint8Array`
 
@@ -59,7 +67,7 @@ The byte array.
 
 ***
 
-### encode()
+### encode() {#encode}
 
 > `static` **encode**(`bytes`): `string`
 

package/docs/reference/classes/Base64Url.md

@@ -13,9 +13,17 @@ https://www.rfc-editor.org/rfc/rfc4648#section-5.
 
 `Base64Url`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### decode()
+### decode() {#decode}
 
 > `static` **decode**(`base64Url`): `Uint8Array`
 
@@ -37,7 +45,7 @@ The byte array.
 
 ***
 
-### encode()
+### encode() {#encode}
 
 > `static` **encode**(`bytes`): `string`
 

package/docs/reference/classes/BaseError.md

@@ -49,7 +49,7 @@ The source of the error.
 
 `string`
 
-The message as a code.
+The message as an i18n key.
 
 ##### properties?
 
@@ -71,9 +71,9 @@ The cause of error if we have wrapped another error.
 
 ## Properties
 
-### source?
+### source? {#source}
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
 The source of the error.
 
@@ -83,9 +83,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -99,9 +99,9 @@ Any additional information for the error.
 
 ***
 
-### cause?
+### cause? {#cause}
 
-> `optional` **cause**: [`IError`](../interfaces/IError.md)
+> `optional` **cause?**: [`IError`](../interfaces/IError.md)
 
 The cause of the error.
 
@@ -115,7 +115,7 @@ The cause of the error.
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): `BaseError`
 
@@ -137,7 +137,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -159,9 +159,9 @@ The list of all internal errors.
 
 ***
 
-### expand()
+### expand() {#expand}
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -169,19 +169,19 @@ Expand an error tree.
 
 ##### errors
 
-The list of errors to expand.
+[`IError`](../interfaces/IError.md)[] \| `undefined`
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+The list of errors to expand.
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -197,9 +197,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -209,7 +209,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -225,9 +225,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -237,7 +237,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -253,9 +253,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -265,7 +265,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -281,9 +281,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -293,7 +293,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -309,9 +309,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -321,7 +321,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -349,7 +349,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -365,9 +365,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -377,7 +377,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -399,7 +399,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -421,7 +421,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -449,7 +449,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 

package/docs/reference/classes/BitString.md

@@ -22,9 +22,17 @@ The length of the bit string.
 
 `BitString`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### fromBits()
+### fromBits() {#frombits}
 
 > `static` **fromBits**(`bits`, `numberBits`): `BitString`
 
@@ -52,7 +60,7 @@ The new instance of BitString.
 
 ***
 
-### getBit()
+### getBit() {#getbit}
 
 > **getBit**(`index`): `boolean`
 
@@ -78,7 +86,7 @@ GeneralError if the index is out of range.
 
 ***
 
-### setBit()
+### setBit() {#setbit}
 
 > **setBit**(`index`, `value`): `void`
 
@@ -108,7 +116,7 @@ GeneralError if the index is out of range.
 
 ***
 
-### getBits()
+### getBits() {#getbits}
 
 > **getBits**(): `Uint8Array`
 
@@ -122,7 +130,7 @@ The bits stored in a Uint8Array.
 
 ***
 
-### getLength()
+### getLength() {#getlength}
 
 > **getLength**(): `number`