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

package/docs/reference/classes/Is.md

@@ -14,7 +14,7 @@ Class to check types of objects.
 
 ## Methods
 
-### undefined()
+### undefined() {#undefined}
 
 > `static` **undefined**(`value`): `value is undefined`
 
@@ -36,7 +36,7 @@ True if the value is a empty.
 
 ***
 
-### null()
+### null() {#null}
 
 > `static` **null**(`value`): `value is null`
 
@@ -58,7 +58,7 @@ True if the value is a empty.
 
 ***
 
-### empty()
+### empty() {#empty}
 
 > `static` **empty**(`value`): value is null \| undefined
 
@@ -80,7 +80,7 @@ True if the value is a empty.
 
 ***
 
-### notEmpty()
+### notEmpty() {#notempty}
 
 > `static` **notEmpty**(`value`): `boolean`
 
@@ -102,7 +102,7 @@ True if the value is a not empty.
 
 ***
 
-### string()
+### string() {#string}
 
 > `static` **string**(`value`): `value is string`
 
@@ -124,7 +124,7 @@ True if the value is a string.
 
 ***
 
-### stringValue()
+### stringValue() {#stringvalue}
 
 > `static` **stringValue**(`value`): `value is string`
 
@@ -146,7 +146,7 @@ True if the value is a string.
 
 ***
 
-### json()
+### json() {#json}
 
 > `static` **json**(`value`): `value is string`
 
@@ -168,7 +168,7 @@ True if the value is a JSON string.
 
 ***
 
-### stringBase64()
+### stringBase64() {#stringbase64}
 
 > `static` **stringBase64**(`value`): `value is string`
 
@@ -190,7 +190,7 @@ True if the value is a base64 string.
 
 ***
 
-### stringBase64Url()
+### stringBase64Url() {#stringbase64url}
 
 > `static` **stringBase64Url**(`value`): `value is string`
 
@@ -212,7 +212,7 @@ True if the value is a base64 string.
 
 ***
 
-### stringBase58()
+### stringBase58() {#stringbase58}
 
 > `static` **stringBase58**(`value`): `value is string`
 
@@ -234,9 +234,9 @@ True if the value is a base58 string.
 
 ***
 
-### stringHex()
+### stringHex() {#stringhex}
 
-> `static` **stringHex**(`value`, `allowPrefix`): `value is string`
+> `static` **stringHex**(`value`, `allowPrefix?`): `value is string`
 
 Is the value a hex string.
 
@@ -248,7 +248,7 @@ Is the value a hex string.
 
 The value to test.
 
-##### allowPrefix
+##### allowPrefix?
 
 `boolean` = `false`
 
@@ -262,9 +262,9 @@ True if the value is a hex string.
 
 ***
 
-### stringHexLength()
+### stringHexLength() {#stringhexlength}
 
-> `static` **stringHexLength**(`value`, `length`, `allowPrefix`): `value is string`
+> `static` **stringHexLength**(`value`, `length`, `allowPrefix?`): `value is string`
 
 Is the value a hex string of fixed length.
 
@@ -282,7 +282,7 @@ The value to test.
 
 The length to test.
 
-##### allowPrefix
+##### allowPrefix?
 
 `boolean` = `false`
 
@@ -296,7 +296,7 @@ True if the value is a hex string of required length.
 
 ***
 
-### number()
+### number() {#number}
 
 > `static` **number**(`value`): `value is number`
 
@@ -318,7 +318,7 @@ True if the value is a number.
 
 ***
 
-### integer()
+### integer() {#integer}
 
 > `static` **integer**(`value`): `value is number`
 
@@ -340,7 +340,7 @@ True if the value is an integer.
 
 ***
 
-### bigint()
+### bigint() {#bigint}
 
 > `static` **bigint**(`value`): `value is bigint`
 
@@ -362,7 +362,7 @@ True if the value is a big integer.
 
 ***
 
-### boolean()
+### boolean() {#boolean}
 
 > `static` **boolean**(`value`): `value is boolean`
 
@@ -384,7 +384,7 @@ True if the value is a boolean.
 
 ***
 
-### date()
+### date() {#date}
 
 > `static` **date**(`value`): `value is Date`
 
@@ -406,7 +406,7 @@ True if the value is a date.
 
 ***
 
-### dateEmpty()
+### dateEmpty() {#dateempty}
 
 > `static` **dateEmpty**(`value`): `boolean`
 
@@ -428,7 +428,7 @@ True if the value is an empty date.
 
 ***
 
-### dateString()
+### dateString() {#datestring}
 
 > `static` **dateString**(`value`): `boolean`
 
@@ -450,7 +450,7 @@ True if the value is a string in ISO 8601 date format.
 
 ***
 
-### dateTimeString()
+### dateTimeString() {#datetimestring}
 
 > `static` **dateTimeString**(`value`): `boolean`
 
@@ -472,7 +472,7 @@ True if the value is a string in ISO 8601 date/time format.
 
 ***
 
-### timeString()
+### timeString() {#timestring}
 
 > `static` **timeString**(`value`): `boolean`
 
@@ -494,7 +494,7 @@ True if the value is a string in ISO 8601 time format.
 
 ***
 
-### timestampSeconds()
+### timestampSeconds() {#timestampseconds}
 
 > `static` **timestampSeconds**(`value`): `value is number`
 
@@ -516,7 +516,7 @@ True if the value is a date.
 
 ***
 
-### timestampMilliseconds()
+### timestampMilliseconds() {#timestampmilliseconds}
 
 > `static` **timestampMilliseconds**(`value`): `value is number`
 
@@ -538,7 +538,7 @@ True if the value is a date.
 
 ***
 
-### object()
+### object() {#object}
 
 > `static` **object**\<`T`\>(`value`): `value is T`
 
@@ -566,7 +566,7 @@ True if the value is a object.
 
 ***
 
-### objectValue()
+### objectValue() {#objectvalue}
 
 > `static` **objectValue**\<`T`\>(`value`): `value is T`
 
@@ -594,7 +594,7 @@ True if the value is a object.
 
 ***
 
-### array()
+### array() {#array}
 
 > `static` **array**\<`T`\>(`value`): `value is T[]`
 
@@ -622,7 +622,7 @@ True if the value is an array.
 
 ***
 
-### arrayValue()
+### arrayValue() {#arrayvalue}
 
 > `static` **arrayValue**\<`T`\>(`value`): `value is T[]`
 
@@ -650,7 +650,7 @@ True if the value is an array with at least one element.
 
 ***
 
-### arrayOneOf()
+### arrayOneOf() {#arrayoneof}
 
 > `static` **arrayOneOf**\<`T`\>(`value`, `options`): `value is T`
 
@@ -684,7 +684,7 @@ True if the value is an element from the options array.
 
 ***
 
-### uint8Array()
+### uint8Array() {#uint8array}
 
 > `static` **uint8Array**(`value`): `value is Uint8Array<ArrayBufferLike>`
 
@@ -706,7 +706,7 @@ True if the value is a Uint8Array.
 
 ***
 
-### typedArray()
+### typedArray() {#typedarray}
 
 > `static` **typedArray**(`value`): value is Uint8Array\<ArrayBufferLike\> \| Int8Array\<ArrayBufferLike\> \| Uint16Array\<ArrayBufferLike\> \| Int16Array\<ArrayBufferLike\> \| Uint32Array\<ArrayBufferLike\> \| Int32Array\<ArrayBufferLike\> \| Float32Array\<ArrayBufferLike\> \| Float64Array\<ArrayBufferLike\>
 
@@ -728,7 +728,7 @@ True if the value is a TypedArray.
 
 ***
 
-### function()
+### function() {#function}
 
 > `static` **function**\<`T`\>(`value`): `value is T`
 
@@ -756,7 +756,7 @@ True if the value is a function.
 
 ***
 
-### email()
+### email() {#email}
 
 > `static` **email**(`value`): `value is string`
 
@@ -778,7 +778,7 @@ True if the value is a string.
 
 ***
 
-### promise()
+### promise() {#promise}
 
 > `static` **promise**\<`T`\>(`value`): `value is Promise<T>`
 
@@ -806,7 +806,7 @@ True if the value is a promise.
 
 ***
 
-### regexp()
+### regexp() {#regexp}
 
 > `static` **regexp**(`value`): `value is RegExp`
 
@@ -828,7 +828,7 @@ True if the value is a regexp.
 
 ***
 
-### class()
+### class() {#class}
 
 > `static` **class**\<`T`\>(`obj`): `obj is (args: any[]) => T`
 
@@ -853,3 +853,31 @@ The object to check.
 `obj is (args: any[]) => T`
 
 True if the object is a class, false otherwise.
+
+***
+
+### uuidV7() {#uuidv7}
+
+> `static` **uuidV7**(`value`, `format?`): `value is string`
+
+Is the value a uuidV7 string.
+
+#### Parameters
+
+##### value
+
+`unknown`
+
+The value to test.
+
+##### format?
+
+`"standard"` \| `"compact"`
+
+The format of the UUIDv7 string.
+
+#### Returns
+
+`value is string`
+
+True if the value is a uuidV7 string.

package/docs/reference/classes/JsonHelper.md

@@ -14,7 +14,7 @@ Helpers methods for JSON objects.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### canonicalize()
+### canonicalize() {#canonicalize}
 
 > `static` **canonicalize**(`object`): `string`
 
@@ -45,7 +45,7 @@ The serialized object.
 
 ***
 
-### diff()
+### diff() {#diff}
 
 > `static` **diff**\<`T`\>(`object1`, `object2`): [`IPatchOperation`](../interfaces/IPatchOperation.md)[]
 
@@ -80,7 +80,7 @@ The list of patches.
 
 ***
 
-### patch()
+### patch() {#patch}
 
 > `static` **patch**\<`T`\>(`object`, `patches`): `T`
 
@@ -119,7 +119,7 @@ GeneralError if the patch fails.
 
 ***
 
-### stringifyEx()
+### stringifyEx() {#stringifyex}
 
 > `static` **stringifyEx**(`object`, `space?`): `string`
 
@@ -135,9 +135,9 @@ 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`
 
-`string` | `number`
+Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
 
 #### Returns
 
@@ -147,7 +147,7 @@ The stringified object.
 
 ***
 
-### parseEx()
+### parseEx() {#parseex}
 
 > `static` **parseEx**(`json`): `any`
 
@@ -169,7 +169,7 @@ The object.
 
 ***
 
-### stringifyExReplacer()
+### stringifyExReplacer() {#stringifyexreplacer}
 
 > `static` **stringifyExReplacer**(`this`, `key`, `value`): `unknown`
 
@@ -203,7 +203,7 @@ The value.
 
 ***
 
-### parseExReviver()
+### parseExReviver() {#parseexreviver}
 
 > `static` **parseExReviver**(`this`, `key`, `value`): `unknown`
 

package/docs/reference/classes/Mutex.md

@@ -0,0 +1,128 @@
+# Class: Mutex
+
+A cross-thread mutex built on Atomics and SharedArrayBuffer.
+
+When isMainThread is true (main thread or fork-mode child process) the class acts as
+the authoritative registry: it creates a SharedArrayBuffer-backed Int32Array for each
+key on first use and never discards it, because worker threads may hold references to
+the same underlying memory.
+
+When isMainThread is false (a true worker thread) the class synchronously negotiates
+the shared buffer with the main thread on first use of each key, then caches it locally.
+The main thread must call Mutex.handleWorkerMessage(msg) from its worker message handler
+before that worker first calls Mutex.lock().
+
+The lock is not re-entrant: a thread that already holds a key and calls lock() again on
+the same key will block until the timeout elapses.
+
+## Constructors
+
+### Constructor
+
+> **new Mutex**(): `Mutex`
+
+#### Returns
+
+`Mutex`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### lock() {#lock}
+
+> `static` **lock**(`key`, `options?`): `boolean`
+
+Acquires a lock for the given key. If the lock is already held, it will wait until it is released or until the timeout is reached.
+The lock is not re-entrant: if the same thread tries to acquire the same lock again, it will deadlock until the timeout is reached.
+
+WARNING: this method calls Atomics.wait internally. On the main thread this blocks the Node.js event loop for the
+duration of the wait. Do not call from the main thread while a worker thread may simultaneously need to fetch a
+buffer for a new mutex key, as that fetch requires the main thread's message loop to be running and will deadlock.
+
+#### Parameters
+
+##### key
+
+`string`
+
+The key to lock on.
+
+##### options?
+
+Lock options.
+
+###### timeoutMs?
+
+`number`
+
+The maximum time to wait for the lock in milliseconds, default is 5000.
+
+###### throwOnTimeout?
+
+`boolean`
+
+Whether to throw an error if the lock could not be acquired within the timeout, default is false.
+
+#### Returns
+
+`boolean`
+
+True if the lock was acquired, false if it timed out and throwOnTimeout is false.
+
+#### Throws
+
+GeneralError if the key is invalid or if the lock could not be acquired within the timeout and throwOnTimeout is true.
+
+***
+
+### unlock() {#unlock}
+
+> `static` **unlock**(`key`): `void`
+
+Releases the lock for the given key.
+
+#### Parameters
+
+##### key
+
+`string`
+
+The key to unlock.
+
+#### Returns
+
+`void`
+
+#### Throws
+
+GeneralError if the key is invalid or the lock is not currently held.
+
+***
+
+### handleWorkerMessage() {#handleworkermessage}
+
+> `static` **handleWorkerMessage**(`msg`): `boolean`
+
+Inspect a message received from a worker and, if it is a Mutex buffer-fetch request,
+respond to it synchronously. Call from the main thread's worker message handler.
+
+#### Parameters
+
+##### msg
+
+`unknown`
+
+The raw message received from the worker.
+
+#### Returns
+
+`boolean`
+
+True if the message was a Mutex protocol message and was handled, false otherwise.