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

package/docs/reference/classes/Coerce.md

@@ -14,9 +14,9 @@ Coerce an object from one type to another.
 
 ## Methods
 
-### string()
+### string() {#string}
 
-> `static` **string**(`value`): `undefined` \| `string`
+> `static` **string**(`value`): `string` \| `undefined`
 
 Coerce the value to a string.
 
@@ -30,7 +30,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The value if it can be coerced.
 
@@ -40,9 +40,9 @@ TypeError If the value can not be coerced.
 
 ***
 
-### number()
+### number() {#number}
 
-> `static` **number**(`value`): `undefined` \| `number`
+> `static` **number**(`value`): `number` \| `undefined`
 
 Coerce the value to a number.
 
@@ -56,7 +56,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `number`
+`number` \| `undefined`
 
 The value if it can be coerced.
 
@@ -66,9 +66,9 @@ TypeError If the value can not be coerced.
 
 ***
 
-### integer()
+### integer() {#integer}
 
-> `static` **integer**(`value`): `undefined` \| `number`
+> `static` **integer**(`value`): `number` \| `undefined`
 
 Coerce the value to an integer.
 
@@ -82,7 +82,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `number`
+`number` \| `undefined`
 
 The value if it can be coerced.
 
@@ -92,9 +92,9 @@ TypeError If the value can not be coerced.
 
 ***
 
-### bigint()
+### bigint() {#bigint}
 
-> `static` **bigint**(`value`): `undefined` \| `bigint`
+> `static` **bigint**(`value`): `bigint` \| `undefined`
 
 Coerce the value to a bigint.
 
@@ -108,7 +108,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `bigint`
+`bigint` \| `undefined`
 
 The value if it can be coerced.
 
@@ -118,9 +118,9 @@ TypeError If the value can not be coerced.
 
 ***
 
-### boolean()
+### boolean() {#boolean}
 
-> `static` **boolean**(`value`): `undefined` \| `boolean`
+> `static` **boolean**(`value`): `boolean` \| `undefined`
 
 Coerce the value to a boolean.
 
@@ -134,7 +134,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `boolean`
+`boolean` \| `undefined`
 
 The value if it can be coerced.
 
@@ -144,9 +144,9 @@ TypeError If the value can not be coerced.
 
 ***
 
-### date()
+### date() {#date}
 
-> `static` **date**(`value`): `undefined` \| `Date`
+> `static` **date**(`value`): `Date` \| `undefined`
 
 Coerce the value to a date.
 
@@ -160,7 +160,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `Date`
+`Date` \| `undefined`
 
 The value if it can be coerced.
 
@@ -170,9 +170,9 @@ TypeError If the value can not be coerced.
 
 ***
 
-### dateTime()
+### dateTime() {#datetime}
 
-> `static` **dateTime**(`value`): `undefined` \| `Date`
+> `static` **dateTime**(`value`): `Date` \| `undefined`
 
 Coerce the value to a date/time.
 
@@ -186,7 +186,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `Date`
+`Date` \| `undefined`
 
 The value if it can be coerced.
 
@@ -196,9 +196,9 @@ TypeError If the value can not be coerced.
 
 ***
 
-### time()
+### time() {#time}
 
-> `static` **time**(`value`): `undefined` \| `Date`
+> `static` **time**(`value`): `Date` \| `undefined`
 
 Coerce the value to a time.
 
@@ -212,7 +212,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `Date`
+`Date` \| `undefined`
 
 The value if it can be coerced.
 
@@ -222,9 +222,9 @@ TypeError If the value can not be coerced.
 
 ***
 
-### object()
+### object() {#object}
 
-> `static` **object**\<`T`\>(`value`): `undefined` \| `T`
+> `static` **object**\<`T`\>(`value`): `T` \| `undefined`
 
 Coerce the value to an object.
 
@@ -244,7 +244,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `T`
+`T` \| `undefined`
 
 The value if it can be coerced.
 
@@ -254,9 +254,9 @@ TypeError If the value can not be coerced.
 
 ***
 
-### uint8Array()
+### uint8Array() {#uint8array}
 
-> `static` **uint8Array**(`value`): `undefined` \| `Uint8Array`\<`ArrayBufferLike`\>
+> `static` **uint8Array**(`value`): `Uint8Array`\<`ArrayBufferLike`\> \| `undefined`
 
 Coerce the value to a Uint8Array.
 
@@ -270,7 +270,7 @@ The value to coerce.
 
 #### Returns
 
-`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>
+`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`
 
 The value if it can be coerced.
 
@@ -280,7 +280,7 @@ TypeError If the value can not be coerced.
 
 ***
 
-### byType()
+### byType() {#bytype}
 
 > `static` **byType**(`value`, `type?`): `unknown`
 

package/docs/reference/classes/Compression.md

@@ -12,9 +12,17 @@ A class to handle compression.
 
 `Compression`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### compress()
+### compress() {#compress}
 
 > `static` **compress**(`bytes`, `type`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
@@ -42,7 +50,7 @@ The compressed bytes.
 
 ***
 
-### decompress()
+### decompress() {#decompress}
 
 > `static` **decompress**(`compressedBytes`, `type`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 

package/docs/reference/classes/ConflictError.md

@@ -10,7 +10,7 @@ Class to handle errors which are triggered by conflicting data.
 
 ### Constructor
 
-> **new ConflictError**(`source`, `message`, `conflictId?`, `conflicts?`, `cause?`): `ConflictError`
+> **new ConflictError**(`source`, `message`, `conflictId?`, `conflicts?`, `properties?`, `cause?`): `ConflictError`
 
 Create a new instance of ConflictError.
 
@@ -26,7 +26,7 @@ The source of the error.
 
 `string`
 
-The message as a code.
+The message as an i18n key.
 
 ##### conflictId?
 
@@ -40,6 +40,10 @@ The id that has conflicts.
 
 The conflicts that occurred.
 
+##### properties?
+
+Any additional information for the error.
+
 ##### cause?
 
 `unknown`
@@ -56,9 +60,9 @@ The cause or the error if we have wrapped another error.
 
 ## Properties
 
-### source?
+### source? {#source}
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
 The source of the error.
 
@@ -68,9 +72,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -84,9 +88,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.
 
@@ -96,7 +100,7 @@ The cause of the error.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -104,7 +108,7 @@ Runtime name for the class.
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
 
@@ -130,7 +134,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -156,9 +160,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.
 
@@ -166,13 +170,13 @@ 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.
 
@@ -182,7 +186,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -198,9 +202,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -214,7 +218,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -230,9 +234,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -246,7 +250,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -262,9 +266,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -278,7 +282,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -294,9 +298,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -310,7 +314,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -326,9 +330,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -342,7 +346,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -374,7 +378,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -390,9 +394,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -406,7 +410,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -432,7 +436,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -458,7 +462,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -490,7 +494,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 

package/docs/reference/classes/Converter.md

@@ -14,7 +14,7 @@ Convert arrays to and from different formats.
 
 ## Methods
 
-### bytesToUtf8()
+### bytesToUtf8() {#bytestoutf8}
 
 > `static` **bytesToUtf8**(`array`, `startIndex?`, `length?`): `string`
 
@@ -48,7 +48,7 @@ The array formatted as UTF8.
 
 ***
 
-### utf8ToBytes()
+### utf8ToBytes() {#utf8tobytes}
 
 > `static` **utf8ToBytes**(`utf8`): `Uint8Array`
 
@@ -70,9 +70,9 @@ The array.
 
 ***
 
-### bytesToHex()
+### bytesToHex() {#bytestohex}
 
-> `static` **bytesToHex**(`array`, `includePrefix`, `startIndex?`, `length?`, `reverse?`): `string`
+> `static` **bytesToHex**(`array`, `includePrefix?`, `startIndex?`, `length?`, `reverse?`): `string`
 
 Encode a raw array to hex string.
 
@@ -84,7 +84,7 @@ Encode a raw array to hex string.
 
 The bytes to encode.
 
-##### includePrefix
+##### includePrefix?
 
 `boolean` = `false`
 
@@ -116,7 +116,7 @@ The array formatted as hex.
 
 ***
 
-### hexToBytes()
+### hexToBytes() {#hextobytes}
 
 > `static` **hexToBytes**(`hex`, `reverse?`): `Uint8Array`
 
@@ -144,9 +144,9 @@ The array.
 
 ***
 
-### utf8ToHex()
+### utf8ToHex() {#utf8tohex}
 
-> `static` **utf8ToHex**(`utf8`, `includePrefix`): `string`
+> `static` **utf8ToHex**(`utf8`, `includePrefix?`): `string`
 
 Convert the UTF8 to hex.
 
@@ -158,7 +158,7 @@ Convert the UTF8 to hex.
 
 The text to convert.
 
-##### includePrefix
+##### includePrefix?
 
 `boolean` = `false`
 
@@ -172,7 +172,7 @@ The hex version of the bytes.
 
 ***
 
-### hexToUtf8()
+### hexToUtf8() {#hextoutf8}
 
 > `static` **hexToUtf8**(`hex`): `string`
 
@@ -194,7 +194,7 @@ The UTF8 version of the bytes.
 
 ***
 
-### bytesToBinary()
+### bytesToBinary() {#bytestobinary}
 
 > `static` **bytesToBinary**(`bytes`): `string`
 
@@ -216,7 +216,7 @@ A binary string of the bytes.
 
 ***
 
-### binaryToBytes()
+### binaryToBytes() {#binarytobytes}
 
 > `static` **binaryToBytes**(`binary`): `Uint8Array`
 
@@ -238,7 +238,7 @@ The bytes.
 
 ***
 
-### bytesToBase64()
+### bytesToBase64() {#bytestobase64}
 
 > `static` **bytesToBase64**(`bytes`): `string`
 
@@ -260,7 +260,7 @@ A base64 string of the bytes.
 
 ***
 
-### base64ToBytes()
+### base64ToBytes() {#base64tobytes}
 
 > `static` **base64ToBytes**(`base64`): `Uint8Array`
 
@@ -282,7 +282,7 @@ The bytes.
 
 ***
 
-### bytesToBase64Url()
+### bytesToBase64Url() {#bytestobase64url}
 
 > `static` **bytesToBase64Url**(`bytes`): `string`
 
@@ -304,7 +304,7 @@ A base64 url string of the bytes.
 
 ***
 
-### base64UrlToBytes()
+### base64UrlToBytes() {#base64urltobytes}
 
 > `static` **base64UrlToBytes**(`base64Url`): `Uint8Array`
 
@@ -326,7 +326,7 @@ The bytes.
 
 ***
 
-### bytesToBase58()
+### bytesToBase58() {#bytestobase58}
 
 > `static` **bytesToBase58**(`bytes`): `string`
 
@@ -348,7 +348,7 @@ A base58 string of the bytes.
 
 ***
 
-### base58ToBytes()
+### base58ToBytes() {#base58tobytes}
 
 > `static` **base58ToBytes**(`base58`): `Uint8Array`
 

package/docs/reference/classes/EnvHelper.md

@@ -14,7 +14,7 @@ Environment variable helper.
 
 ## Methods
 
-### envToJson()
+### envToJson() {#envtojson}
 
 > `static` **envToJson**\<`T`\>(`envVars`, `prefix?`): `T`
 

package/docs/reference/classes/ErrorHelper.md

@@ -14,7 +14,7 @@ Error helper functions.
 
 ## Methods
 
-### formatErrors()
+### formatErrors() {#formaterrors}
 
 > `static` **formatErrors**(`error`, `includeDetails?`): `string`[]
 
@@ -42,7 +42,7 @@ The error formatted including any causes errors.
 
 ***
 
-### localizeErrors()
+### localizeErrors() {#localizeerrors}
 
 > `static` **localizeErrors**(`error`): [`IError`](../interfaces/IError.md)[]
 
@@ -64,9 +64,9 @@ The localized version of the errors flattened.
 
 ***
 
-### formatValidationErrors()
+### formatValidationErrors() {#formatvalidationerrors}
 
-> `static` **formatValidationErrors**(`error`): `undefined` \| `string`
+> `static` **formatValidationErrors**(`error`): `string` \| `undefined`
 
 Localize the content of an error and any causes.
 
@@ -80,6 +80,6 @@ The error to format.
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The localized version of the errors flattened.