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

package/docs/reference/classes/GuardError.md

@@ -26,7 +26,7 @@ The source of the error.
 
 `string`
 
-The message as a code.
+The message as an i18n key.
 
 ##### propertyName
 
@@ -56,9 +56,9 @@ The property options which might be allowed.
 
 ## Properties
 
-### source?
+### source? {#source}
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
 The source of the error.
 
@@ -68,9 +68,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -84,9 +84,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 +96,7 @@ The cause of the error.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -104,7 +104,7 @@ Runtime name for the class.
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
 
@@ -130,7 +130,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -156,9 +156,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 +166,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 +182,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -198,9 +198,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -214,7 +214,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -230,9 +230,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -246,7 +246,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -262,9 +262,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -278,7 +278,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -294,9 +294,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -310,7 +310,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -326,9 +326,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -342,7 +342,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -374,7 +374,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -390,9 +390,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -406,7 +406,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -432,7 +432,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -458,7 +458,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -490,7 +490,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 

package/docs/reference/classes/Guards.md

@@ -14,7 +14,7 @@ Class to handle guard operations for parameters.
 
 ## Methods
 
-### defined()
+### defined() {#defined}
 
 > `static` **defined**(`source`, `property`, `value`): `asserts value`
 
@@ -50,7 +50,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### string()
+### string() {#string}
 
 > `static` **string**(`source`, `property`, `value`): `asserts value is string`
 
@@ -86,7 +86,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### stringValue()
+### stringValue() {#stringvalue}
 
 > `static` **stringValue**(`source`, `property`, `value`): `asserts value is string`
 
@@ -122,7 +122,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### json()
+### json() {#json}
 
 > `static` **json**(`source`, `property`, `value`): `asserts value is string`
 
@@ -158,7 +158,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### stringBase64()
+### stringBase64() {#stringbase64}
 
 > `static` **stringBase64**(`source`, `property`, `value`): `asserts value is string`
 
@@ -194,7 +194,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### stringBase64Url()
+### stringBase64Url() {#stringbase64url}
 
 > `static` **stringBase64Url**(`source`, `property`, `value`): `asserts value is string`
 
@@ -230,7 +230,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### stringBase58()
+### stringBase58() {#stringbase58}
 
 > `static` **stringBase58**(`source`, `property`, `value`): `asserts value is string`
 
@@ -266,9 +266,9 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### stringHex()
+### stringHex() {#stringhex}
 
-> `static` **stringHex**(`source`, `property`, `value`, `allowPrefix`): `asserts value is string`
+> `static` **stringHex**(`source`, `property`, `value`, `allowPrefix?`): `asserts value is string`
 
 Is the property a string with a hex value.
 
@@ -292,7 +292,7 @@ The name of the property.
 
 The value to test.
 
-##### allowPrefix
+##### allowPrefix?
 
 `boolean` = `false`
 
@@ -308,9 +308,9 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### stringHexLength()
+### stringHexLength() {#stringhexlength}
 
-> `static` **stringHexLength**(`source`, `property`, `value`, `length`, `allowPrefix`): `asserts value is string`
+> `static` **stringHexLength**(`source`, `property`, `value`, `length`, `allowPrefix?`): `asserts value is string`
 
 Is the property a string with a hex value with fixed length.
 
@@ -340,7 +340,7 @@ The value to test.
 
 The length of the string to match.
 
-##### allowPrefix
+##### allowPrefix?
 
 `boolean` = `false`
 
@@ -356,7 +356,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### number()
+### number() {#number}
 
 > `static` **number**(`source`, `property`, `value`): `asserts value is number`
 
@@ -392,7 +392,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### integer()
+### integer() {#integer}
 
 > `static` **integer**(`source`, `property`, `value`): `asserts value is number`
 
@@ -428,7 +428,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### bigint()
+### bigint() {#bigint}
 
 > `static` **bigint**(`source`, `property`, `value`): `asserts value is bigint`
 
@@ -464,7 +464,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### boolean()
+### boolean() {#boolean}
 
 > `static` **boolean**(`source`, `property`, `value`): `asserts value is boolean`
 
@@ -500,7 +500,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### date()
+### date() {#date}
 
 > `static` **date**(`source`, `property`, `value`): `asserts value is Date`
 
@@ -536,7 +536,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### timestampMilliseconds()
+### timestampMilliseconds() {#timestampmilliseconds}
 
 > `static` **timestampMilliseconds**(`source`, `property`, `value`): `asserts value is number`
 
@@ -572,7 +572,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### timestampSeconds()
+### timestampSeconds() {#timestampseconds}
 
 > `static` **timestampSeconds**(`source`, `property`, `value`): `asserts value is number`
 
@@ -608,7 +608,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### object()
+### object() {#object}
 
 > `static` **object**\<`T`\>(`source`, `property`, `value`): `asserts value is T`
 
@@ -650,7 +650,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### objectValue()
+### objectValue() {#objectvalue}
 
 > `static` **objectValue**\<`T`\>(`source`, `property`, `value`): `asserts value is T`
 
@@ -692,7 +692,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### array()
+### array() {#array}
 
 > `static` **array**\<`T`\>(`source`, `property`, `value`): `asserts value is T[]`
 
@@ -734,7 +734,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### arrayValue()
+### arrayValue() {#arrayvalue}
 
 > `static` **arrayValue**\<`T`\>(`source`, `property`, `value`): `asserts value is T[]`
 
@@ -776,7 +776,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### arrayOneOf()
+### arrayOneOf() {#arrayoneof}
 
 > `static` **arrayOneOf**\<`T`\>(`source`, `property`, `value`, `options`): `asserts value is T`
 
@@ -824,7 +824,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### arrayStartsWith()
+### arrayStartsWith() {#arraystartswith}
 
 > `static` **arrayStartsWith**\<`T`\>(`source`, `property`, `value`, `startValues`): `asserts value is T[]`
 
@@ -872,7 +872,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### arrayEndsWith()
+### arrayEndsWith() {#arrayendswith}
 
 > `static` **arrayEndsWith**\<`T`\>(`source`, `property`, `value`, `endValues`): `asserts value is T[]`
 
@@ -920,7 +920,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### uint8Array()
+### uint8Array() {#uint8array}
 
 > `static` **uint8Array**(`source`, `property`, `value`): `asserts value is Uint8Array<ArrayBufferLike>`
 
@@ -956,12 +956,18 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### function()
+### function() {#function}
 
-> `static` **function**(`source`, `property`, `value`): `boolean`
+> `static` **function**\<`T`\>(`source`, `property`, `value`): `asserts value is T`
 
 Is the property a function.
 
+#### Type Parameters
+
+##### T
+
+`T` *extends* (...`args`) => `any` = (...`args`) => `any`
+
 #### Parameters
 
 ##### source
@@ -984,9 +990,7 @@ The value to test.
 
 #### Returns
 
-`boolean`
-
-True if the value is a function.
+`asserts value is T`
 
 #### Throws
 
@@ -994,7 +998,7 @@ GuardError If the value does not match the assertion.
 
 ***
 
-### email()
+### email() {#email}
 
 > `static` **email**(`source`, `property`, `value`): `asserts value is string`
 
@@ -1027,3 +1031,45 @@ The value to test.
 #### Throws
 
 GuardError If the value does not match the assertion.
+
+***
+
+### uuidV7() {#uuidv7}
+
+> `static` **uuidV7**(`source`, `property`, `value`, `format?`): `asserts value is string`
+
+Is the property a string containing uuidV7.
+
+#### Parameters
+
+##### source
+
+`string`
+
+The source of the error.
+
+##### property
+
+`string`
+
+The name of the property.
+
+##### value
+
+`unknown`
+
+The value to test.
+
+##### format?
+
+`"standard"` \| `"compact"`
+
+The format of the uuidV7, either standard or compact.
+
+#### Returns
+
+`asserts value is string`
+
+#### Throws
+
+GuardError If the value does not match the assertion.

package/docs/reference/classes/HexHelper.md

@@ -14,7 +14,7 @@ Helper methods for hex conversions.
 
 ## Methods
 
-### stripPrefix()
+### stripPrefix() {#stripprefix}
 
 > `static` **stripPrefix**(`hex`): `string`
 
@@ -36,7 +36,7 @@ The stripped hex without the prefix.
 
 ***
 
-### addPrefix()
+### addPrefix() {#addprefix}
 
 > `static` **addPrefix**(`hex`): `string`
 
@@ -58,7 +58,7 @@ The hex with the prefix.
 
 ***
 
-### hasPrefix()
+### hasPrefix() {#hasprefix}
 
 > `static` **hasPrefix**(`hex`): `boolean`
 
@@ -80,9 +80,9 @@ True if the hex string has the prefix.
 
 ***
 
-### isHex()
+### isHex() {#ishex}
 
-> `static` **isHex**(`value`, `allowPrefix`): `boolean`
+> `static` **isHex**(`value`, `allowPrefix?`): `boolean`
 
 Is the data hex format.
 
@@ -94,7 +94,7 @@ Is the data hex format.
 
 The value to test.
 
-##### allowPrefix
+##### allowPrefix?
 
 `boolean` = `false`