2.0.2

dist/semafy.cjs

@@ -556,10 +556,19 @@ var __defProp$1 = Object.defineProperty;
 var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$1 = (obj, key, value) => __defNormalProp$1(obj, key + "" , value);
 class SharedLock {
+  /**
+   * @param mutex - The shared mutex to associate.
+   */
   constructor(mutex) {
+    /**
+     * The associated mutex.
+     */
     __publicField$1(this, "_mutex");
     this._mutex = mutex;
   }
+  /**
+   * The associated mutex.
+   */
   get mutex() {
     return this._mutex;
   }

dist/semafy.d.ts

@@ -516,9 +516,27 @@ declare class TimedMutex extends Mutex implements TimedLockable {
  */
 declare function lockGuard<T>(mutex: BasicLockable, callbackfn: () => T | Promise<T>): Promise<T>;
 
+/**
+ * A shared mutex wrapper.
+ *
+ * Locking a SharedLock locks the associated shared mutex in shared mode.
+ *
+ * If the shared mutex implements {@link SharedTimedLockable}, then SharedLock
+ * will also implement it. Otherwise, attempts to use timed methods
+ * (`tryLockFor`, `tryLockUntil`) will result in errors.
+ */
 declare class SharedLock implements TimedLockable {
+    /**
+     * The associated mutex.
+     */
     protected _mutex: SharedLockable;
+    /**
+     * @param mutex - The shared mutex to associate.
+     */
     constructor(mutex: SharedLockable);
+    /**
+     * The associated mutex.
+     */
     get mutex(): SharedLockable;
     get ownsLock(): boolean;
     lock(): Promise<void>;

dist/semafy.mjs

@@ -554,10 +554,19 @@ var __defProp$1 = Object.defineProperty;
 var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$1 = (obj, key, value) => __defNormalProp$1(obj, key + "" , value);
 class SharedLock {
+  /**
+   * @param mutex - The shared mutex to associate.
+   */
   constructor(mutex) {
+    /**
+     * The associated mutex.
+     */
     __publicField$1(this, "_mutex");
     this._mutex = mutex;
   }
+  /**
+   * The associated mutex.
+   */
   get mutex() {
     return this._mutex;
   }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "semafy",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "A robust cross-agent synchronization library.",
   "license": "MIT",
   "author": "Michael Rojas <[email protected]> (https://github.com/havelessbemore)",

src/utils/sharedLock.ts

@@ -2,13 +2,31 @@ import type { SharedLockable } from "../types/sharedLockable";
 import type { SharedTimedLockable } from "../types/sharedTimedLockable";
 import type { TimedLockable } from "../types/timedLockable";
 
+/**
+ * A shared mutex wrapper.
+ *
+ * Locking a SharedLock locks the associated shared mutex in shared mode.
+ *
+ * If the shared mutex implements {@link SharedTimedLockable}, then SharedLock
+ * will also implement it. Otherwise, attempts to use timed methods
+ * (`tryLockFor`, `tryLockUntil`) will result in errors.
+ */
 export class SharedLock implements TimedLockable {
+  /**
+   * The associated mutex.
+   */
   protected _mutex: SharedLockable;
 
+  /**
+   * @param mutex - The shared mutex to associate.
+   */
   constructor(mutex: SharedLockable) {
     this._mutex = mutex;
   }
 
+  /**
+   * The associated mutex.
+   */
   get mutex(): SharedLockable {
     return this._mutex;
   }