@twin.org/core 0.9.2 → 0.9.3-next.10

package/docs/reference/interfaces/IFacade.md

@@ -0,0 +1,32 @@
+# Interface: IFacade\<T\>
+
+A facade wraps a component so a cross cutting concern can be applied to it without the
+component being modified. The wrapped component is returned in place of the original.
+
+## Type Parameters
+
+### T
+
+`T` = `unknown`
+
+## Methods
+
+### wrap() {#wrap}
+
+> **wrap**(`target`): `T`
+
+Wrap the target, returning a replacement.
+
+#### Parameters
+
+##### target
+
+`T`
+
+The component to wrap.
+
+#### Returns
+
+`T`
+
+The wrapped component.

package/docs/reference/interfaces/IMutexWaiter.md

@@ -0,0 +1,37 @@
+# Interface: IMutexWaiter
+
+A caller queued on a mutex key, waiting to be handed the lock.
+
+## Properties
+
+### settled {#settled}
+
+> **settled**: `boolean`
+
+Has the waiter already been granted the lock or given up waiting.
+
+***
+
+### resolve? {#resolve}
+
+> `optional` **resolve?**: (`granted`) => `void`
+
+Resolves the queued caller, true when it now owns the lock.
+
+#### Parameters
+
+##### granted
+
+`boolean`
+
+#### Returns
+
+`void`
+
+***
+
+### timer? {#timer}
+
+> `optional` **timer?**: `Timeout`
+
+Timer which enforces the waiter's deadline.

package/docs/reference/variables/FacadeFactory.md

@@ -0,0 +1,5 @@
+# Variable: FacadeFactory
+
+> `const` **FacadeFactory**: [`Factory`](../classes/Factory.md)\<[`IFacade`](../interfaces/IFacade.md)\<`unknown`\>\>
+
+Factory for creating implementation of facade types.

package/locales/en.json

@@ -91,7 +91,10 @@
 		"factory": {
 			"noUnregister": "There is no {typeName} registered with the name \"{name}\"",
 			"noGet": "The requested {typeName} \"{name}\" does not exist in the factory",
-			"noCreate": "The requested {typeName} \"{name}\" cannot be created by the factory, with params \"{params}\""
+			"noCreate": "The requested {typeName} \"{name}\" cannot be created by the factory, with params \"{params}\"",
+			"noFacade": "The requested facade \"{name}\" is not registered, so it cannot be applied to the {typeName} factory",
+			"noFacadeOnFacades": "Facades cannot be applied to the facade factory itself",
+			"noFacadeWrap": "The facade \"{name}\" did not return a wrapped instance for the {typeName} factory"
 		},
 		"bitString": {
 			"outOfRange": "The index should be >= 0 and less than the length of the bit string, the index is \"{index}\" and the number of bit is \"{numberBits}\""
@@ -111,7 +114,7 @@
 		"mutex": {
 			"lockNotFound": "The key \"{key}\" has no active lock",
 			"lockAlreadyReleased": "The key \"{key}\" is not currently locked",
-			"lockTimeout": "Failed to acquire lock for key \"{key}\" within the timeout of {timeout} milliseconds",
+			"lockTimeout": "Failed to acquire lock for key \"{key}\" within the timeout of {timeoutMs} milliseconds",
 			"bufferFetchFailed": "Failed to retrieve shared buffer for key \"{key}\" from the main thread",
 			"invalidTimeout": "The timeout value \"{timeoutMs}\" is invalid, it must be a non-negative integer"
 		},

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.9.2",
+	"version": "0.9.3-next.10",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,7 @@
 		"node": ">=24.0.0"
 	},
 	"dependencies": {
-		"@twin.org/nameof": "^0.9.2",
+		"@twin.org/nameof": "0.9.3-next.10",
 		"intl-messageformat": "11.2.13",
 		"rfc6902": "5.3.0"
 	},