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

package/docs/reference/classes/Is.md

@@ -4,13 +4,13 @@ Class to check types of objects.
 
 ## Constructors
 
-### new Is()
+### Constructor
 
-> **new Is**(): [`Is`](Is.md)
+> **new Is**(): `Is`
 
 #### Returns
 
-[`Is`](Is.md)
+`Is`
 
 ## Methods
 
@@ -22,7 +22,9 @@ Is the property undefined.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -42,7 +44,9 @@ Is the property null.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -62,7 +66,9 @@ Is the property null or undefined.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -82,7 +88,9 @@ Is the property is not null or undefined.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -102,7 +110,9 @@ Is the value a string.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -122,7 +132,9 @@ Is the value a string.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -142,7 +154,9 @@ Is the value a JSON string.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -162,7 +176,9 @@ Is the value a base64 string.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -182,7 +198,9 @@ Is the value a base64 url string.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -194,6 +212,28 @@ True if the value is a base64 string.
 
 ***
 
+### stringBase58()
+
+> `static` **stringBase58**(`value`): `value is string`
+
+Is the value a base58 string.
+
+#### Parameters
+
+##### value
+
+`unknown`
+
+The value to test.
+
+#### Returns
+
+`value is string`
+
+True if the value is a base58 string.
+
+***
+
 ### stringHex()
 
 > `static` **stringHex**(`value`, `allowPrefix`): `value is string`
@@ -202,11 +242,15 @@ Is the value a hex string.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
-• **allowPrefix**: `boolean` = `false`
+##### allowPrefix
+
+`boolean` = `false`
 
 Allow the hex to have the 0x prefix.
 
@@ -226,15 +270,21 @@ Is the value a hex string of fixed length.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
-• **length**: `number`
+##### length
+
+`number`
 
 The length to test.
 
-• **allowPrefix**: `boolean` = `false`
+##### allowPrefix
+
+`boolean` = `false`
 
 Allow the hex to have the 0x prefix.
 
@@ -254,7 +304,9 @@ Is the value a number.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -274,7 +326,9 @@ Is the value an integer.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -294,7 +348,9 @@ Is the value a big integer.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -314,7 +370,9 @@ Is the value a boolean.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -334,7 +392,9 @@ Is the value a date.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -354,7 +414,9 @@ Is the value an empty date.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -374,7 +436,9 @@ Is the value a date string.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -394,7 +458,9 @@ Is the value a date string.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -414,7 +480,9 @@ Is the value a time string.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -434,7 +502,9 @@ Is the value a timestamp in seconds.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -454,7 +524,9 @@ Is the value a timestamp in milliseconds.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -474,11 +546,15 @@ Is the value an object.
 
 #### Type Parameters
 
-• **T** = `object`
+##### T
+
+`T` = \{[`id`: `string`]: `unknown`; \}
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -498,11 +574,15 @@ Is the value an object with at least one property.
 
 #### Type Parameters
 
-• **T** = `object`
+##### T
+
+`T` = \{[`id`: `string`]: `unknown`; \}
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -522,11 +602,15 @@ Is the value an array.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -546,11 +630,15 @@ Is the value an array with at least one element.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -570,15 +658,21 @@ Is the value an array with at least one element.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **value**: `T`
+##### value
+
+`T`
 
 The value to test.
 
-• **options**: `T`[]
+##### options
+
+`T`[]
 
 The options the value must be one of.
 
@@ -592,19 +686,21 @@ True if the value is an element from the options array.
 
 ### uint8Array()
 
-> `static` **uint8Array**(`value`): `value is Uint8Array`
+> `static` **uint8Array**(`value`): `value is Uint8Array<ArrayBufferLike>`
 
 Is the value a Uint8Array.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
 #### Returns
 
-`value is Uint8Array`
+`value is Uint8Array<ArrayBufferLike>`
 
 True if the value is a Uint8Array.
 
@@ -612,19 +708,21 @@ True if the value is a Uint8Array.
 
 ### typedArray()
 
-> `static` **typedArray**(`value`): value is Int8Array \| Uint8Array \| Int16Array \| Uint16Array \| Int32Array \| Uint32Array \| Float32Array \| Float64Array
+> `static` **typedArray**(`value`): value is Uint8Array\<ArrayBufferLike\> \| Int8Array\<ArrayBufferLike\> \| Uint16Array\<ArrayBufferLike\> \| Int16Array\<ArrayBufferLike\> \| Uint32Array\<ArrayBufferLike\> \| Int32Array\<ArrayBufferLike\> \| Float32Array\<ArrayBufferLike\> \| Float64Array\<ArrayBufferLike\>
 
 Is the value a TypedArray.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
 #### Returns
 
-value is Int8Array \| Uint8Array \| Int16Array \| Uint16Array \| Int32Array \| Uint32Array \| Float32Array \| Float64Array
+value is Uint8Array\<ArrayBufferLike\> \| Int8Array\<ArrayBufferLike\> \| Uint16Array\<ArrayBufferLike\> \| Int16Array\<ArrayBufferLike\> \| Uint32Array\<ArrayBufferLike\> \| Int32Array\<ArrayBufferLike\> \| Float32Array\<ArrayBufferLike\> \| Float64Array\<ArrayBufferLike\>
 
 True if the value is a TypedArray.
 
@@ -632,19 +730,21 @@ True if the value is a TypedArray.
 
 ### function()
 
-> `static` **function**(`value`): `value is Function`
+> `static` **function**(`value`): `value is (args: unknown[]) => unknown`
 
 Is the property a function.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
 #### Returns
 
-`value is Function`
+`value is (args: unknown[]) => unknown`
 
 True if the value is a function.
 
@@ -658,7 +758,9 @@ Is the value a string formatted as an email address.
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -678,11 +780,15 @@ Is the value a promise.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **value**: `unknown`
+##### value
+
+`unknown`
 
 The value to test.
 
@@ -691,3 +797,25 @@ The value to test.
 `value is Promise<T>`
 
 True if the value is a promise.
+
+***
+
+### regexp()
+
+> `static` **regexp**(`value`): `value is RegExp`
+
+Is the value a regexp.
+
+#### Parameters
+
+##### value
+
+`unknown`
+
+The value to test.
+
+#### Returns
+
+`value is RegExp`
+
+True if the value is a regexp.

package/docs/reference/classes/JsonHelper.md

@@ -4,13 +4,13 @@ Helpers methods for JSON objects.
 
 ## Constructors
 
-### new JsonHelper()
+### Constructor
 
-> **new JsonHelper**(): [`JsonHelper`](JsonHelper.md)
+> **new JsonHelper**(): `JsonHelper`
 
 #### Returns
 
-[`JsonHelper`](JsonHelper.md)
+`JsonHelper`
 
 ## Methods
 
@@ -23,7 +23,9 @@ Based on https://www.rfc-editor.org/rfc/rfc8785.
 
 #### Parameters
 
-• **object**: `unknown`
+##### object
+
+`unknown`
 
 The object to be serialized.
 
@@ -44,15 +46,21 @@ Based on https://www.rfc-editor.org/rfc/rfc6902.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **object1**: `T`
+##### object1
+
+`T`
 
 The first object.
 
-• **object2**: `T`
+##### object2
+
+`T`
 
 The second object.
 
@@ -73,15 +81,21 @@ Based on https://www.rfc-editor.org/rfc/rfc6902.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **object**: `T`
+##### object
+
+`T`
 
 The object to patch.
 
-• **patches**: [`IPatchOperation`](../interfaces/IPatchOperation.md)[]
+##### patches
+
+[`IPatchOperation`](../interfaces/IPatchOperation.md)[]
 
 The second object.
 
@@ -90,3 +104,125 @@ The second object.
 `T`
 
 The updated object.
+
+#### Throws
+
+GeneralError if the patch fails.
+
+***
+
+### stringifyEx()
+
+> `static` **stringifyEx**(`object`, `space?`): `string`
+
+Stringify the JSON with support for extended data types date/bigint/uint8array.
+
+#### Parameters
+
+##### object
+
+`any`
+
+The object to stringify.
+
+##### space?
+
+Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
+
+`string` | `number`
+
+#### Returns
+
+`string`
+
+The stringified object.
+
+***
+
+### parseEx()
+
+> `static` **parseEx**(`json`): `any`
+
+Parse the JSON string with support for extended data types date/bigint/uint8array.
+
+#### Parameters
+
+##### json
+
+`string`
+
+The object to pause.
+
+#### Returns
+
+`any`
+
+The object.
+
+***
+
+### stringifyExReplacer()
+
+> `static` **stringifyExReplacer**(`this`, `key`, `value`): `unknown`
+
+Replacer function to handle extended data types.
+
+#### Parameters
+
+##### this
+
+`any`
+
+The object.
+
+##### key
+
+`string`
+
+The key.
+
+##### value
+
+`unknown`
+
+The value.
+
+#### Returns
+
+`unknown`
+
+The value.
+
+***
+
+### parseExReviver()
+
+> `static` **parseExReviver**(`this`, `key`, `value`): `unknown`
+
+Reviver function to handle extended data types.
+
+#### Parameters
+
+##### this
+
+`any`
+
+The object.
+
+##### key
+
+`string`
+
+The key.
+
+##### value
+
+`unknown`
+
+The value.
+
+#### Returns
+
+`unknown`
+
+The value.