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

package/docs/reference/classes/AsyncCache.md

@@ -4,25 +4,27 @@ Cache the results from asynchronous requests.
 
 ## Constructors
 
-### new AsyncCache()
+### Constructor
 
-> **new AsyncCache**(): [`AsyncCache`](AsyncCache.md)
+> **new AsyncCache**(): `AsyncCache`
 
 #### Returns
 
-[`AsyncCache`](AsyncCache.md)
+`AsyncCache`
 
 ## Methods
 
 ### exec()
 
-> `static` **exec**\<`T`\>(`key`, `ttlMs`, `requestMethod`): `undefined` \| `Promise`\<`T`\>
+> `static` **exec**\<`T`\>(`key`, `ttlMs`, `requestMethod`, `cacheFailures?`): `undefined` \| `Promise`\<`T`\>
 
 Execute an async request and cache the result.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
@@ -44,6 +46,12 @@ The TTL of the entry in the cache.
 
 The method to call if not cached.
 
+##### cacheFailures?
+
+`boolean`
+
+Cache failure results, defaults to false.
+
 #### Returns
 
 `undefined` \| `Promise`\<`T`\>
@@ -60,7 +68,9 @@ Get an entry from the cache.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
@@ -80,13 +90,15 @@ The item from the cache if it exists.
 
 ### set()
 
-> `static` **set**\<`T`\>(`key`, `value`, `ttlMs`?): `Promise`\<`void`\>
+> `static` **set**\<`T`\>(`key`, `value`, `ttlMs?`): `Promise`\<`void`\>
 
 Set an entry into the cache.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
@@ -138,7 +150,7 @@ The key to remove from the cache.
 
 ### clearCache()
 
-> `static` **clearCache**(`prefix`?): `void`
+> `static` **clearCache**(`prefix?`): `void`
 
 Clear the cache.
 

package/docs/reference/classes/Base32.md

@@ -4,13 +4,13 @@ Class to help with base63 Encoding/Decoding.
 
 ## Constructors
 
-### new Base32()
+### Constructor
 
-> **new Base32**(): [`Base32`](Base32.md)
+> **new Base32**(): `Base32`
 
 #### Returns
 
-[`Base32`](Base32.md)
+`Base32`
 
 ## Methods
 

package/docs/reference/classes/Base58.md

@@ -4,13 +4,13 @@ Class to help with base58 Encoding/Decoding.
 
 ## Constructors
 
-### new Base58()
+### Constructor
 
-> **new Base58**(): [`Base58`](Base58.md)
+> **new Base58**(): `Base58`
 
 #### Returns
 
-[`Base58`](Base58.md)
+`Base58`
 
 ## Methods
 

package/docs/reference/classes/Base64.md

@@ -5,13 +5,13 @@ Sourced from https://github.com/beatgammit/base64-js.
 
 ## Constructors
 
-### new Base64()
+### Constructor
 
-> **new Base64**(): [`Base64`](Base64.md)
+> **new Base64**(): `Base64`
 
 #### Returns
 
-[`Base64`](Base64.md)
+`Base64`
 
 ## Methods
 

package/docs/reference/classes/Base64Url.md

@@ -5,13 +5,13 @@ https://www.rfc-editor.org/rfc/rfc4648#section-5.
 
 ## Constructors
 
-### new Base64Url()
+### Constructor
 
-> **new Base64Url**(): [`Base64Url`](Base64Url.md)
+> **new Base64Url**(): `Base64Url`
 
 #### Returns
 
-[`Base64Url`](Base64Url.md)
+`Base64Url`
 
 ## Methods
 

package/docs/reference/classes/BaseError.md

@@ -25,9 +25,9 @@ Class to handle errors.
 
 ## Constructors
 
-### new BaseError()
+### Constructor
 
-> **new BaseError**(`name`, `source`, `message`, `properties`?, `inner`?): [`BaseError`](BaseError.md)
+> **new BaseError**(`name`, `source`, `message`, `properties?`, `inner?`): `BaseError`
 
 Create a new instance of BaseError.
 
@@ -63,7 +63,7 @@ The inner error if we have wrapped another error.
 
 #### Returns
 
-[`BaseError`](BaseError.md)
+`BaseError`
 
 #### Overrides
 
@@ -113,7 +113,7 @@ The inner error if there was one.
 
 ### fromError()
 
-> `static` **fromError**(`err`): [`BaseError`](BaseError.md)
+> `static` **fromError**(`err`): `BaseError`
 
 Construct an error from an existing one.
 
@@ -127,7 +127,7 @@ The existing error.
 
 #### Returns
 
-[`BaseError`](BaseError.md)
+`BaseError`
 
 The new instance.
 

package/docs/reference/classes/BitString.md

@@ -4,9 +4,9 @@ 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.
 
@@ -20,13 +20,13 @@ 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.
 
@@ -46,7 +46,7 @@ The number of bits in the bit string.
 
 #### Returns
 
-[`BitString`](BitString.md)
+`BitString`
 
 The new instance of BitString.
 

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
 
@@ -230,7 +230,9 @@ Coerce the value to an object.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
@@ -280,7 +282,7 @@ TypeError If the value can not be coerced.
 
 ### byType()
 
-> `static` **byType**(`value`, `type`?): `unknown`
+> `static` **byType**(`value`, `type?`): `unknown`
 
 Coerces a value based on the coercion type.
 

package/docs/reference/classes/Compression.md

@@ -4,13 +4,13 @@ A class to handle compression.
 
 ## Constructors
 
-### new Compression()
+### Constructor
 
-> **new Compression**(): [`Compression`](Compression.md)
+> **new Compression**(): `Compression`
 
 #### Returns
 
-[`Compression`](Compression.md)
+`Compression`
 
 ## Methods
 

package/docs/reference/classes/ConflictError.md

@@ -8,9 +8,9 @@ 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.
 
@@ -48,11 +48,11 @@ 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
 
@@ -64,7 +64,7 @@ The source of the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`source`](BaseError.md#source-1)
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
 
 ***
 
@@ -80,7 +80,7 @@ Any additional information for the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties-1)
+[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties)
 
 ***
 
@@ -92,7 +92,7 @@ The inner error if there was one.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner-1)
+[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
 
 ***
 

package/docs/reference/classes/Converter.md

@@ -4,19 +4,19 @@ Convert arrays to and from different formats.
 
 ## Constructors
 
-### new Converter()
+### Constructor
 
-> **new Converter**(): [`Converter`](Converter.md)
+> **new Converter**(): `Converter`
 
 #### Returns
 
-[`Converter`](Converter.md)
+`Converter`
 
 ## Methods
 
 ### bytesToUtf8()
 
-> `static` **bytesToUtf8**(`array`, `startIndex`?, `length`?): `string`
+> `static` **bytesToUtf8**(`array`, `startIndex?`, `length?`): `string`
 
 Encode a raw array to UTF8 string.
 
@@ -72,7 +72,7 @@ The array.
 
 ### bytesToHex()
 
-> `static` **bytesToHex**(`array`, `includePrefix`, `startIndex`?, `length`?, `reverse`?): `string`
+> `static` **bytesToHex**(`array`, `includePrefix`, `startIndex?`, `length?`, `reverse?`): `string`
 
 Encode a raw array to hex string.
 
@@ -118,7 +118,7 @@ The array formatted as hex.
 
 ### hexToBytes()
 
-> `static` **hexToBytes**(`hex`, `reverse`?): `Uint8Array`
+> `static` **hexToBytes**(`hex`, `reverse?`): `Uint8Array`
 
 Decode a hex string to raw array.
 

package/docs/reference/classes/EnvHelper.md

@@ -4,25 +4,27 @@ Environment variable helper.
 
 ## Constructors
 
-### new EnvHelper()
+### Constructor
 
-> **new EnvHelper**(): [`EnvHelper`](EnvHelper.md)
+> **new EnvHelper**(): `EnvHelper`
 
 #### Returns
 
-[`EnvHelper`](EnvHelper.md)
+`EnvHelper`
 
 ## Methods
 
 ### envToJson()
 
-> `static` **envToJson**\<`T`\>(`envVars`, `prefix`?): `T`
+> `static` **envToJson**\<`T`\>(`envVars`, `prefix?`): `T`
 
 Get the environment variable as an object with camel cased names.
 
 #### Type Parameters
 
-• **T** = \{\}
+##### T
+
+`T` = \{[`id`: `string`]: `string`; \}
 
 #### Parameters
 

package/docs/reference/classes/ErrorHelper.md

@@ -4,13 +4,13 @@ Error helper functions.
 
 ## Constructors
 
-### new ErrorHelper()
+### Constructor
 
-> **new ErrorHelper**(): [`ErrorHelper`](ErrorHelper.md)
+> **new ErrorHelper**(): `ErrorHelper`
 
 #### Returns
 
-[`ErrorHelper`](ErrorHelper.md)
+`ErrorHelper`
 
 ## Methods
 

package/docs/reference/classes/Factory.md

@@ -4,19 +4,23 @@ Factory for creating implementation of generic types.
 
 ## Type Parameters
 
-• **T**
+### T
+
+`T`
 
 ## Methods
 
 ### createFactory()
 
-> `static` **createFactory**\<`U`\>(`typeName`, `autoInstance`, `matcher`?): [`Factory`](Factory.md)\<`U`\>
+> `static` **createFactory**\<`U`\>(`typeName`, `autoInstance`, `matcher?`): `Factory`\<`U`\>
 
 Create a new factory, which is shared throughout all library instances.
 
 #### Type Parameters
 
-• **U**
+##### U
+
+`U`
 
 #### Parameters
 
@@ -40,7 +44,7 @@ Match the name of the instance.
 
 #### Returns
 
-[`Factory`](Factory.md)\<`U`\>
+`Factory`\<`U`\>
 
 The factory instance.
 
@@ -92,7 +96,9 @@ Register a new generator.
 
 #### Type Parameters
 
-• **U**
+##### U
+
+`U`
 
 #### Parameters
 
@@ -150,7 +156,9 @@ Get a generator instance.
 
 #### Type Parameters
 
-• **U**
+##### U
+
+`U`
 
 #### Parameters
 
@@ -184,7 +192,9 @@ Get a generator instance with no exceptions.
 
 #### Type Parameters
 
-• **U**
+##### U
+
+`U`
 
 #### Parameters
 

package/docs/reference/classes/FilenameHelper.md

@@ -4,13 +4,13 @@ Class to help with filenames.
 
 ## Constructors
 
-### new FilenameHelper()
+### Constructor
 
-> **new FilenameHelper**(): [`FilenameHelper`](FilenameHelper.md)
+> **new FilenameHelper**(): `FilenameHelper`
 
 #### Returns
 
-[`FilenameHelper`](FilenameHelper.md)
+`FilenameHelper`
 
 ## Methods
 

package/docs/reference/classes/GeneralError.md

@@ -8,9 +8,9 @@ Class to handle errors.
 
 ## Constructors
 
-### new GeneralError()
+### Constructor
 
-> **new GeneralError**(`source`, `message`, `properties`?, `inner`?): [`GeneralError`](GeneralError.md)
+> **new GeneralError**(`source`, `message`, `properties?`, `inner?`): `GeneralError`
 
 Create a new instance of GeneralError.
 
@@ -40,11 +40,11 @@ The inner error if we have wrapped another error.
 
 #### Returns
 
-[`GeneralError`](GeneralError.md)
+`GeneralError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -56,7 +56,7 @@ The source of the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`source`](BaseError.md#source-1)
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
 
 ***
 
@@ -72,7 +72,7 @@ Any additional information for the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties-1)
+[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties)
 
 ***
 
@@ -84,7 +84,7 @@ The inner error if there was one.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner-1)
+[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
 
 ***
 

package/docs/reference/classes/GuardError.md

@@ -8,9 +8,9 @@ Class to handle errors which are triggered by data guards.
 
 ## Constructors
 
-### new GuardError()
+### Constructor
 
-> **new GuardError**(`source`, `message`, `propertyName`, `propertyValue`, `propertyOptions`?): [`GuardError`](GuardError.md)
+> **new GuardError**(`source`, `message`, `propertyName`, `propertyValue`, `propertyOptions?`): `GuardError`
 
 Create a new instance of GuardError.
 
@@ -48,11 +48,11 @@ The property options which might be allowed.
 
 #### Returns
 
-[`GuardError`](GuardError.md)
+`GuardError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -64,7 +64,7 @@ The source of the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`source`](BaseError.md#source-1)
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
 
 ***
 
@@ -80,7 +80,7 @@ Any additional information for the error.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties-1)
+[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties)
 
 ***
 
@@ -92,7 +92,7 @@ The inner error if there was one.
 
 #### Inherited from
 
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner-1)
+[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
 
 ***
 

package/docs/reference/classes/Guards.md

@@ -4,13 +4,13 @@ Class to handle guard operations for parameters.
 
 ## Constructors
 
-### new Guards()
+### Constructor
 
-> **new Guards**(): [`Guards`](Guards.md)
+> **new Guards**(): `Guards`
 
 #### Returns
 
-[`Guards`](Guards.md)
+`Guards`
 
 ## Methods
 
@@ -616,7 +616,9 @@ Is the property an object.
 
 #### Type Parameters
 
-• **T** = \{\}
+##### T
+
+`T` = \{[`id`: `string`]: `unknown`; \}
 
 #### Parameters
 
@@ -656,7 +658,9 @@ Is the property is an object with at least one property.
 
 #### Type Parameters
 
-• **T** = \{\}
+##### T
+
+`T` = \{[`id`: `string`]: `unknown`; \}
 
 #### Parameters
 
@@ -696,7 +700,9 @@ Is the property is an array.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
@@ -736,7 +742,9 @@ Is the property is an array with at least one item.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
@@ -776,7 +784,9 @@ Is the property one of a list of items.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters