@twin.org/core 0.0.1-next.9 → 0.0.2-next.3

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
 
@@ -22,15 +22,21 @@ Is the property defined.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -52,15 +58,21 @@ Is the property a string.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -82,15 +94,57 @@ Is the property a string with a value.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
+
+The source of the error.
+
+##### property
+
+`string`
+
+The name of the property.
+
+##### value
+
+`unknown`
+
+The value to test.
+
+#### Returns
+
+`asserts value is string`
+
+#### Throws
+
+GuardError If the value does not match the assertion.
+
+***
+
+### json()
+
+> `static` **json**(`source`, `property`, `value`): `asserts value is string`
+
+Is the property a JSON value.
+
+#### Parameters
+
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -112,15 +166,21 @@ Is the property a base64 string.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -142,15 +202,57 @@ Is the property a base64 url string.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
+
+The value to test.
+
+#### Returns
+
+`asserts value is string`
+
+#### Throws
+
+GuardError If the value does not match the assertion.
+
+***
+
+### stringBase58()
+
+> `static` **stringBase58**(`source`, `property`, `value`): `asserts value is string`
+
+Is the property a base58 string.
+
+#### Parameters
+
+##### source
+
+`string`
+
+The source of the error.
+
+##### property
+
+`string`
+
+The name of the property.
+
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -172,19 +274,27 @@ Is the property a string with a hex value.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
-• **allowPrefix**: `boolean` = `false`
+##### allowPrefix
+
+`boolean` = `false`
 
 Allow the hex to have the 0x prefix.
 
@@ -206,23 +316,33 @@ Is the property a string with a hex value with fixed length.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
-• **length**: `number`
+##### length
+
+`number`
 
 The length of the string to match.
 
-• **allowPrefix**: `boolean` = `false`
+##### allowPrefix
+
+`boolean` = `false`
 
 Allow the hex to have the 0x prefix.
 
@@ -244,15 +364,21 @@ Is the property a number.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -274,15 +400,21 @@ Is the property an integer.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -304,15 +436,21 @@ Is the property a bigint.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -334,15 +472,21 @@ Is the property a boolean.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -364,15 +508,21 @@ Is the property a date.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -394,15 +544,21 @@ Is the property a timestamp in milliseconds.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -424,15 +580,21 @@ Is the property a timestamp in seconds.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -454,19 +616,27 @@ Is the property an object.
 
 #### Type Parameters
 
-• **T** = `object`
+##### T
+
+`T` = \{[`id`: `string`]: `unknown`; \}
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -488,19 +658,27 @@ Is the property is an object with at least one property.
 
 #### Type Parameters
 
-• **T** = `object`
+##### T
+
+`T` = \{[`id`: `string`]: `unknown`; \}
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -522,19 +700,27 @@ Is the property is an array.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -556,19 +742,27 @@ Is the property is an array with at least one item.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -590,23 +784,33 @@ Is the property one of a list of items.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `T`
+##### value
+
+`T`
 
 The value to test.
 
-• **options**: `T`[]
+##### options
+
+`T`[]
 
 The options the value must be one of.
 
@@ -620,29 +824,131 @@ GuardError If the value does not match the assertion.
 
 ***
 
+### arrayStartsWith()
+
+> `static` **arrayStartsWith**\<`T`\>(`source`, `property`, `value`, `startValues`): `asserts value is T[]`
+
+Does the array start with the specified data.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### source
+
+`string`
+
+The source of the error.
+
+##### property
+
+`string`
+
+The name of the property.
+
+##### value
+
+`unknown`
+
+The value to test.
+
+##### startValues
+
+[`ObjectOrArray`](../type-aliases/ObjectOrArray.md)\<`T`\>
+
+The values that must start the array.
+
+#### Returns
+
+`asserts value is T[]`
+
+#### Throws
+
+GuardError If the value does not match the assertion.
+
+***
+
+### arrayEndsWith()
+
+> `static` **arrayEndsWith**\<`T`\>(`source`, `property`, `value`, `endValues`): `asserts value is T[]`
+
+Does the array end with the specified data.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### source
+
+`string`
+
+The source of the error.
+
+##### property
+
+`string`
+
+The name of the property.
+
+##### value
+
+`unknown`
+
+The value to test.
+
+##### endValues
+
+[`ObjectOrArray`](../type-aliases/ObjectOrArray.md)\<`T`\>
+
+The values that must end the array.
+
+#### Returns
+
+`asserts value is T[]`
+
+#### Throws
+
+GuardError If the value does not match the assertion.
+
+***
+
 ### uint8Array()
 
-> `static` **uint8Array**(`source`, `property`, `value`): `asserts value is Uint8Array`
+> `static` **uint8Array**(`source`, `property`, `value`): `asserts value is Uint8Array<ArrayBufferLike>`
 
 Is the property a Uint8Array.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
 #### Returns
 
-`asserts value is Uint8Array`
+`asserts value is Uint8Array<ArrayBufferLike>`
 
 #### Throws
 
@@ -658,15 +964,21 @@ Is the property a function.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -690,15 +1002,21 @@ Is the property a string formatted as an email address.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **property**: `string`
+##### property
+
+`string`
 
 The name of the property.
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.