@stryke/helpers 0.6.2 → 0.7.0

package/dist/mutex.d.ts

@@ -3,6 +3,7 @@
  * It allows only one async task to access a critical section at a time.
  *
  * @example
+ * ```typescript
  * const mutex = new Mutex();
  *
  * async function criticalSection() {
@@ -16,12 +17,13 @@
  *
  * criticalSection();
  * criticalSection(); // This call will wait until the first call releases the mutex.
+ * ```
  */
 export declare class Mutex {
     private semaphore;
     /**
      * Checks if the mutex is currently locked.
-     * @returns {boolean} True if the mutex is locked, false otherwise.
+     * @returns True if the mutex is locked, false otherwise.
      *
      * @example
      * const mutex = new Mutex();
@@ -34,9 +36,10 @@ export declare class Mutex {
     get isLocked(): boolean;
     /**
      * Acquires the mutex, blocking if necessary until it is available.
-     * @returns {Promise<void>} A promise that resolves when the mutex is acquired.
+     * @returns A promise that resolves when the mutex is acquired.
      *
      * @example
+     * ```typescript
      * const mutex = new Mutex();
      * await mutex.acquire();
      * try {
@@ -44,12 +47,14 @@ export declare class Mutex {
      * } finally {
      *   mutex.release();
      * }
+     * ```
      */
     acquire(): Promise<void>;
     /**
      * Releases the mutex, allowing another waiting task to proceed.
      *
      * @example
+     * ```typescript
      * const mutex = new Mutex();
      * await mutex.acquire();
      * try {
@@ -57,6 +62,7 @@ export declare class Mutex {
      * } finally {
      *   mutex.release(); // Allows another waiting task to proceed.
      * }
+     * ```
      */
     release(): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/helpers",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "type": "module",
   "description": "A package containing miscellaneous helper functions that are used across many different Storm Software projects.",
   "repository": {
@@ -11,9 +11,9 @@
   "private": false,
   "publishConfig": { "access": "public" },
   "dependencies": {
-    "@stryke/convert": "^0.2.2",
-    "@stryke/type-checks": "^0.3.4",
-    "@stryke/types": "^0.8.4"
+    "@stryke/convert": "^0.3.0",
+    "@stryke/type-checks": "^0.3.6",
+    "@stryke/types": "^0.8.6"
   },
   "devDependencies": {},
   "sideEffects": false,
@@ -440,5 +440,6 @@
   },
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts"
+  "types": "./dist/index.d.ts",
+  "gitHead": "ea7a3a1d68d4a4361cc04d6f5bf6219a5bc4a2a2"
 }