effect 4.0.0-beta.70 → 4.0.0-beta.72

package/dist/TxReentrantLock.d.ts

@@ -1,8 +1,44 @@
 /**
- * TxReentrantLock is a transactional read/write lock with reentrant semantics using Software
- * Transactional Memory (STM). Multiple readers can hold the lock concurrently, OR a single
- * writer can hold exclusive access. A fiber holding a write lock may acquire additional
- * read or write locks (reentrancy).
+ * The `TxReentrantLock` module provides a transactional read/write lock whose
+ * ownership is tracked per fiber. Multiple fibers may hold read locks at the
+ * same time, while a write lock gives one fiber exclusive access.
+ *
+ * **Mental model**
+ *
+ * The lock stores reader counts and an optional writer count in transactional
+ * state. A fiber can reacquire locks it already owns, so nested read or write
+ * sections are safe as long as each acquisition is matched by a release. A
+ * write acquisition waits when another fiber owns a read or write lock, and a
+ * read acquisition waits when another fiber owns the write lock.
+ *
+ * **Common tasks**
+ *
+ * - Use `withReadLock` to run an effect that may share access with other
+ *   readers.
+ * - Use `withWriteLock` or `withLock` to run an effect with exclusive access.
+ * - Use `readLock` or `writeLock` when lock ownership should be tied to an
+ *   existing scope.
+ *
+ * **Example** (Protecting a read/write workflow)
+ *
+ * ```ts
+ * import { Effect, Ref, TxReentrantLock } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const lock = yield* TxReentrantLock.make()
+ *   const state = yield* Ref.make(0)
+ *
+ *   yield* TxReentrantLock.withWriteLock(lock, Ref.update(state, (n) => n + 1))
+ *   return yield* TxReentrantLock.withReadLock(lock, Ref.get(state))
+ * })
+ * ```
+ *
+ * **Gotchas**
+ *
+ * - Manual acquisitions are counted; release the same number of times or use
+ *   the scoped and `with*` helpers.
+ * - Releasing a lock from a fiber that does not own it leaves the lock
+ *   unchanged and returns `0`.
  *
  * @since 4.0.0
  */
@@ -80,9 +116,19 @@ export declare const make: () => Effect.Effect<TxReentrantLock>;
  */
 export declare const acquireRead: (self: TxReentrantLock) => Effect.Effect<number>;
 /**
- * Acquires a write lock. Blocks if any other fiber holds any lock.
- * If the current fiber already holds the write lock, the count is incremented (reentrancy).
- * If the current fiber holds a read lock, the write lock is granted (upgrade).
+ * Acquires the write lock for the current fiber.
+ *
+ * **When to use**
+ *
+ * Use to enter an exclusive section manually when `withWriteLock` is not the
+ * right shape.
+ *
+ * **Details**
+ *
+ * Blocks if any other fiber holds a read or write lock. If the current fiber
+ * already holds the write lock, the count is incremented. If the current fiber
+ * holds a read lock, the write lock is granted as an upgrade.
+ *
  * Returns the current number of write locks held by this fiber.
  *
  * **Example** (Acquiring a write lock)
@@ -103,7 +149,14 @@ export declare const acquireRead: (self: TxReentrantLock) => Effect.Effect<numbe
  */
 export declare const acquireWrite: (self: TxReentrantLock) => Effect.Effect<number>;
 /**
- * Releases a read lock held by the current fiber.
+ * Releases one read lock held by the current fiber.
+ *
+ * **When to use**
+ *
+ * Use to leave a manually acquired read lock.
+ *
+ * **Details**
+ *
  * Returns the remaining number of read locks held by this fiber.
  *
  * **Example** (Releasing a read lock)
@@ -124,7 +177,14 @@ export declare const acquireWrite: (self: TxReentrantLock) => Effect.Effect<numb
  */
 export declare const releaseRead: (self: TxReentrantLock) => Effect.Effect<number>;
 /**
- * Releases a write lock held by the current fiber.
+ * Releases one write lock held by the current fiber.
+ *
+ * **When to use**
+ *
+ * Use to leave a manually acquired write lock.
+ *
+ * **Details**
+ *
  * Returns the remaining number of write locks held by this fiber.
  *
  * **Example** (Releasing a write lock)
@@ -337,7 +397,11 @@ export declare const withWriteLock: {
     <A, E, R>(self: TxReentrantLock, effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R>;
 };
 /**
- * Alias for `withWriteLock`. Runs the provided effect while holding a write lock.
+ * Runs an effect while holding a write lock.
+ *
+ * **When to use**
+ *
+ * Use as the short alias for {@link withWriteLock}.
  *
  * **Example** (Running an effect with exclusive access)
  *
@@ -359,7 +423,11 @@ export declare const withWriteLock: {
  */
 export declare const withLock: {
     /**
-     * Alias for `withWriteLock`. Runs the provided effect while holding a write lock.
+     * Runs an effect while holding a write lock.
+     *
+     * **When to use**
+     *
+     * Use as the short alias for {@link withWriteLock}.
      *
      * **Example** (Running an effect with exclusive access)
      *
@@ -381,7 +449,11 @@ export declare const withLock: {
      */
     <A, E, R>(effect: Effect.Effect<A, E, R>): (self: TxReentrantLock) => Effect.Effect<A, E, R>;
     /**
-     * Alias for `withWriteLock`. Runs the provided effect while holding a write lock.
+     * Runs an effect while holding a write lock.
+     *
+     * **When to use**
+     *
+     * Use as the short alias for {@link withWriteLock}.
      *
      * **Example** (Running an effect with exclusive access)
      *
@@ -444,7 +516,7 @@ export declare const readLocks: (self: TxReentrantLock) => Effect.Effect<number>
  */
 export declare const writeLocks: (self: TxReentrantLock) => Effect.Effect<number>;
 /**
- * Checks if the lock is held by any fiber (read or write).
+ * Checks whether the lock is held by any fiber (read or write).
  *
  * **Example** (Checking whether a lock is held)
  *
@@ -463,7 +535,7 @@ export declare const writeLocks: (self: TxReentrantLock) => Effect.Effect<number
  */
 export declare const locked: (self: TxReentrantLock) => Effect.Effect<boolean>;
 /**
- * Checks if any fiber holds a read lock.
+ * Checks whether any fiber holds a read lock.
  *
  * **Example** (Checking whether a read lock is held)
  *
@@ -482,7 +554,7 @@ export declare const locked: (self: TxReentrantLock) => Effect.Effect<boolean>;
  */
 export declare const readLocked: (self: TxReentrantLock) => Effect.Effect<boolean>;
 /**
- * Checks if any fiber holds a write lock.
+ * Checks whether any fiber holds a write lock.
  *
  * **Example** (Checking whether a write lock is held)
  *
@@ -501,7 +573,7 @@ export declare const readLocked: (self: TxReentrantLock) => Effect.Effect<boolea
  */
 export declare const writeLocked: (self: TxReentrantLock) => Effect.Effect<boolean>;
 /**
- * Checks if the given value is a TxReentrantLock.
+ * Checks whether the given value is a TxReentrantLock.
  *
  * **Example** (Checking for TxReentrantLock values)
  *

package/dist/TxReentrantLock.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TxReentrantLock.d.ts","sourceRoot":"","sources":["../src/TxReentrantLock.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAGnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAG7C,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAGxC,QAAA,MAAM,MAAM,yCAAyC,CAAA;AAgBrD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,eAAgB,SAAQ,WAAW,EAAE,QAAQ;IAC5D,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;CAGjC;AAqBD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,IAAI,QAAO,MAAM,CAAC,MAAM,CAAC,eAAe,CAOjC,CAAA;AAMpB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,WAAW,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAoBrE,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAoCtE,CAAA;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,WAAW,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAiBrE,CAAA;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAgBtE,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,QAAQ,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAItF,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAIvF,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAC5F;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;CAiBjF,CAAA;AAET;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,aAAa,EAAE;IAC1B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAC5F;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;CAiBjF,CAAA;AAET;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAC5F;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;CACzE,CAAA;AAMjB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAQlE,CAAA;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAInE,CAAA;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,MAAM,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAIhE,CAAA;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAIpE,CAAA;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,WAAW,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAIrE,CAAA;AAMJ;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,iBAAiB,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,eAAyC,CAAA"}
+{"version":3,"file":"TxReentrantLock.d.ts","sourceRoot":"","sources":["../src/TxReentrantLock.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAGnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAG7C,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AAGxC,QAAA,MAAM,MAAM,yCAAyC,CAAA;AAgBrD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,eAAgB,SAAQ,WAAW,EAAE,QAAQ;IAC5D,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;CAGjC;AAqBD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,IAAI,QAAO,MAAM,CAAC,MAAM,CAAC,eAAe,CAOjC,CAAA;AAMpB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,WAAW,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAoBrE,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAoCtE,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,WAAW,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAiBrE,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAgBtE,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,QAAQ,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAItF,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAIvF,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAC5F;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;CAiBjF,CAAA;AAET;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,aAAa,EAAE;IAC1B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAC5F;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;CAiBjF,CAAA;AAET;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAC5F;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;CACzE,CAAA;AAMjB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAQlE,CAAA;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAInE,CAAA;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,MAAM,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAIhE,CAAA;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAIpE,CAAA;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,WAAW,GAAI,MAAM,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAIrE,CAAA;AAMJ;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,iBAAiB,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,eAAyC,CAAA"}

package/dist/TxReentrantLock.js

@@ -1,8 +1,44 @@
 /**
- * TxReentrantLock is a transactional read/write lock with reentrant semantics using Software
- * Transactional Memory (STM). Multiple readers can hold the lock concurrently, OR a single
- * writer can hold exclusive access. A fiber holding a write lock may acquire additional
- * read or write locks (reentrancy).
+ * The `TxReentrantLock` module provides a transactional read/write lock whose
+ * ownership is tracked per fiber. Multiple fibers may hold read locks at the
+ * same time, while a write lock gives one fiber exclusive access.
+ *
+ * **Mental model**
+ *
+ * The lock stores reader counts and an optional writer count in transactional
+ * state. A fiber can reacquire locks it already owns, so nested read or write
+ * sections are safe as long as each acquisition is matched by a release. A
+ * write acquisition waits when another fiber owns a read or write lock, and a
+ * read acquisition waits when another fiber owns the write lock.
+ *
+ * **Common tasks**
+ *
+ * - Use `withReadLock` to run an effect that may share access with other
+ *   readers.
+ * - Use `withWriteLock` or `withLock` to run an effect with exclusive access.
+ * - Use `readLock` or `writeLock` when lock ownership should be tied to an
+ *   existing scope.
+ *
+ * **Example** (Protecting a read/write workflow)
+ *
+ * ```ts
+ * import { Effect, Ref, TxReentrantLock } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const lock = yield* TxReentrantLock.make()
+ *   const state = yield* Ref.make(0)
+ *
+ *   yield* TxReentrantLock.withWriteLock(lock, Ref.update(state, (n) => n + 1))
+ *   return yield* TxReentrantLock.withReadLock(lock, Ref.get(state))
+ * })
+ * ```
+ *
+ * **Gotchas**
+ *
+ * - Manual acquisitions are counted; release the same number of times or use
+ *   the scoped and `with*` helpers.
+ * - Releasing a lock from a fiber that does not own it leaves the lock
+ *   unchanged and returns `0`.
  *
  * @since 4.0.0
  */
@@ -103,9 +139,19 @@ export const acquireRead = self => Effect.withFiber(fiber => Effect.gen(function
   return newCount;
 }).pipe(Effect.tx));
 /**
- * Acquires a write lock. Blocks if any other fiber holds any lock.
- * If the current fiber already holds the write lock, the count is incremented (reentrancy).
- * If the current fiber holds a read lock, the write lock is granted (upgrade).
+ * Acquires the write lock for the current fiber.
+ *
+ * **When to use**
+ *
+ * Use to enter an exclusive section manually when `withWriteLock` is not the
+ * right shape.
+ *
+ * **Details**
+ *
+ * Blocks if any other fiber holds a read or write lock. If the current fiber
+ * already holds the write lock, the count is incremented. If the current fiber
+ * holds a read lock, the write lock is granted as an upgrade.
+ *
  * Returns the current number of write locks held by this fiber.
  *
  * **Example** (Acquiring a write lock)
@@ -155,7 +201,14 @@ export const acquireWrite = self => Effect.withFiber(fiber => Effect.gen(functio
   return 1;
 }).pipe(Effect.tx));
 /**
- * Releases a read lock held by the current fiber.
+ * Releases one read lock held by the current fiber.
+ *
+ * **When to use**
+ *
+ * Use to leave a manually acquired read lock.
+ *
+ * **Details**
+ *
  * Returns the remaining number of read locks held by this fiber.
  *
  * **Example** (Releasing a read lock)
@@ -188,7 +241,14 @@ export const releaseRead = self => Effect.withFiber(fiber => Effect.gen(function
   return newCount;
 }).pipe(Effect.tx));
 /**
- * Releases a write lock held by the current fiber.
+ * Releases one write lock held by the current fiber.
+ *
+ * **When to use**
+ *
+ * Use to leave a manually acquired write lock.
+ *
+ * **Details**
+ *
  * Returns the remaining number of write locks held by this fiber.
  *
  * **Example** (Releasing a write lock)
@@ -332,7 +392,11 @@ export const withWriteLock = (...args) => {
   return Effect.acquireUseRelease(acquireWrite(self), () => effect, () => releaseWrite(self));
 };
 /**
- * Alias for `withWriteLock`. Runs the provided effect while holding a write lock.
+ * Runs an effect while holding a write lock.
+ *
+ * **When to use**
+ *
+ * Use as the short alias for {@link withWriteLock}.
  *
  * **Example** (Running an effect with exclusive access)
  *
@@ -407,7 +471,7 @@ export const writeLocks = self => Effect.gen(function* () {
   return Option.isSome(state.writer) ? state.writer.value[1] : 0;
 });
 /**
- * Checks if the lock is held by any fiber (read or write).
+ * Checks whether the lock is held by any fiber (read or write).
  *
  * **Example** (Checking whether a lock is held)
  *
@@ -429,7 +493,7 @@ export const locked = self => Effect.gen(function* () {
   return HashMap.size(state.readers) > 0 || Option.isSome(state.writer);
 });
 /**
- * Checks if any fiber holds a read lock.
+ * Checks whether any fiber holds a read lock.
  *
  * **Example** (Checking whether a read lock is held)
  *
@@ -451,7 +515,7 @@ export const readLocked = self => Effect.gen(function* () {
   return HashMap.size(state.readers) > 0;
 });
 /**
- * Checks if any fiber holds a write lock.
+ * Checks whether any fiber holds a write lock.
  *
  * **Example** (Checking whether a write lock is held)
  *
@@ -476,7 +540,7 @@ export const writeLocked = self => Effect.gen(function* () {
 // Guards
 // =============================================================================
 /**
- * Checks if the given value is a TxReentrantLock.
+ * Checks whether the given value is a TxReentrantLock.
  *
  * **Example** (Checking for TxReentrantLock values)
  *

package/dist/TxReentrantLock.js.map

@@ -1 +1 @@
-{"version":3,"file":"TxReentrantLock.js","names":["Effect","HashMap","NodeInspectSymbol","toJson","Option","pipeArguments","hasProperty","TxRef","TypeId","emptyState","readers","empty","writer","none","TxReentrantLockProto","toJSON","_id","toString","pipe","arguments","make","gen","stateRef","self","Object","create","tx","acquireRead","withFiber","fiber","state","get","fiberId","id","isSome","value","txRetry","currentCount","getOrElse","newCount","set","acquireWrite","readerId","some","releaseRead","newReaders","remove","releaseWrite","isNone","newWriter","readLock","acquireRelease","writeLock","withReadLock","args","length","effect","acquireUseRelease","withWriteLock","withLock","readLocks","total","count","writeLocks","locked","size","readLocked","writeLocked","isTxReentrantLock","u"],"sources":["../src/TxReentrantLock.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;AAQA,OAAO,KAAKA,MAAM,MAAM,aAAa;AACrC,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC,SAASC,iBAAiB,EAAEC,MAAM,QAAQ,kBAAkB;AAC5D,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC,SAASC,aAAa,QAAQ,eAAe;AAC7C,SAASC,WAAW,QAAQ,gBAAgB;AAE5C,OAAO,KAAKC,KAAK,MAAM,YAAY;AAEnC,MAAMC,MAAM,GAAG,sCAAsC;AAWrD,MAAMC,UAAU,GAAc;EAC5BC,OAAO,eAAET,OAAO,CAACU,KAAK,EAAkB;EACxCC,MAAM,eAAER,MAAM,CAACS,IAAI;CACpB;AAgCD,MAAMC,oBAAoB,GAAsD;EAC9E,CAACZ,iBAAiB,IAAC;IACjB,OAAOC,MAAM,CAAC,IAAI,CAAC;EACrB,CAAC;EACDY,MAAMA,CAAA;IACJ,OAAO;MAAEC,GAAG,EAAE;IAAiB,CAAE;EACnC,CAAC;EACDC,QAAQA,CAAA;IACN,OAAO,iBAAiB;EAC1B,CAAC;EACDC,IAAIA,CAAA;IACF,OAAOb,aAAa,CAAC,IAAI,EAAEc,SAAS,CAAC;EACvC;CACD;AAED;AACA;AACA;AAEA;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMC,IAAI,GAAGA,CAAA,KAClBpB,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMC,QAAQ,GAAG,OAAOf,KAAK,CAACa,IAAI,CAAYX,UAAU,CAAC;EACzD,MAAMc,IAAI,GAAGC,MAAM,CAACC,MAAM,CAACX,oBAAoB,CAAC;EAChDS,IAAI,CAACf,MAAM,CAAC,GAAGA,MAAM;EACrBe,IAAI,CAACD,QAAQ,GAAGA,QAAQ;EACxB,OAAOC,IAAI;AACb,CAAC,CAAC,CAACL,IAAI,CAAClB,MAAM,CAAC0B,EAAE,CAAC;AAEpB;AACA;AACA;AAEA;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,MAAMC,WAAW,GAAIJ,IAAqB,IAC/CvB,MAAM,CAAC4B,SAAS,CAAEC,KAAK,IACrB7B,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,MAAMU,OAAO,GAAGH,KAAK,CAACI,EAAE;EAExB;EACA,IAAI7B,MAAM,CAAC8B,MAAM,CAACJ,KAAK,CAAClB,MAAM,CAAC,IAAIkB,KAAK,CAAClB,MAAM,CAACuB,KAAK,CAAC,CAAC,CAAC,KAAKH,OAAO,EAAE;IACpE,OAAO,OAAOhC,MAAM,CAACoC,OAAO;EAC9B;EAEA;EACA,MAAMC,YAAY,GAAGjC,MAAM,CAACkC,SAAS,CAACrC,OAAO,CAAC8B,GAAG,CAACD,KAAK,CAACpB,OAAO,EAAEsB,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;EACnF,MAAMO,QAAQ,GAAGF,YAAY,GAAG,CAAC;EACjC,OAAO9B,KAAK,CAACiC,GAAG,CAACjB,IAAI,CAACD,QAAQ,EAAE;IAC9B,GAAGQ,KAAK;IACRpB,OAAO,EAAET,OAAO,CAACuC,GAAG,CAACV,KAAK,CAACpB,OAAO,EAAEsB,OAAO,EAAEO,QAAQ;GACtD,CAAC;EACF,OAAOA,QAAQ;AACjB,CAAC,CAAC,CAACrB,IAAI,CAAClB,MAAM,CAAC0B,EAAE,CAAC,CACnB;AAEH;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAMe,YAAY,GAAIlB,IAAqB,IAChDvB,MAAM,CAAC4B,SAAS,CAAEC,KAAK,IACrB7B,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,MAAMU,OAAO,GAAGH,KAAK,CAACI,EAAE;EAExB;EACA,IAAI7B,MAAM,CAAC8B,MAAM,CAACJ,KAAK,CAAClB,MAAM,CAAC,IAAIkB,KAAK,CAAClB,MAAM,CAACuB,KAAK,CAAC,CAAC,CAAC,KAAKH,OAAO,EAAE;IACpE,OAAO,OAAOhC,MAAM,CAACoC,OAAO;EAC9B;EAEA;EACA,KAAK,MAAM,CAACM,QAAQ,CAAC,IAAIZ,KAAK,CAACpB,OAAO,EAAE;IACtC,IAAIgC,QAAQ,KAAKV,OAAO,IAAI5B,MAAM,CAACkC,SAAS,CAACrC,OAAO,CAAC8B,GAAG,CAACD,KAAK,CAACpB,OAAO,EAAEgC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE;MAC/F,OAAO,OAAO1C,MAAM,CAACoC,OAAO;IAC9B;EACF;EAEA;EACA,IAAIhC,MAAM,CAAC8B,MAAM,CAACJ,KAAK,CAAClB,MAAM,CAAC,EAAE;IAC/B;IACA,MAAM2B,QAAQ,GAAGT,KAAK,CAAClB,MAAM,CAACuB,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;IAC1C,OAAO5B,KAAK,CAACiC,GAAG,CAACjB,IAAI,CAACD,QAAQ,EAAE;MAC9B,GAAGQ,KAAK;MACRlB,MAAM,EAAER,MAAM,CAACuC,IAAI,CAAC,CAACX,OAAO,EAAEO,QAAQ,CAAU;KACjD,CAAC;IACF,OAAOA,QAAQ;EACjB;EAEA;EACA,OAAOhC,KAAK,CAACiC,GAAG,CAACjB,IAAI,CAACD,QAAQ,EAAE;IAC9B,GAAGQ,KAAK;IACRlB,MAAM,EAAER,MAAM,CAACuC,IAAI,CAAC,CAACX,OAAO,EAAE,CAAC,CAAU;GAC1C,CAAC;EACF,OAAO,CAAC;AACV,CAAC,CAAC,CAACd,IAAI,CAAClB,MAAM,CAAC0B,EAAE,CAAC,CACnB;AAEH;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,MAAMkB,WAAW,GAAIrB,IAAqB,IAC/CvB,MAAM,CAAC4B,SAAS,CAAEC,KAAK,IACrB7B,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,MAAMU,OAAO,GAAGH,KAAK,CAACI,EAAE;EACxB,MAAMI,YAAY,GAAGjC,MAAM,CAACkC,SAAS,CAACrC,OAAO,CAAC8B,GAAG,CAACD,KAAK,CAACpB,OAAO,EAAEsB,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;EAEnF,IAAIK,YAAY,IAAI,CAAC,EAAE,OAAO,CAAC;EAE/B,MAAME,QAAQ,GAAGF,YAAY,GAAG,CAAC;EACjC,MAAMQ,UAAU,GAAGN,QAAQ,KAAK,CAAC,GAC7BtC,OAAO,CAAC6C,MAAM,CAAChB,KAAK,CAACpB,OAAO,EAAEsB,OAAO,CAAC,GACtC/B,OAAO,CAACuC,GAAG,CAACV,KAAK,CAACpB,OAAO,EAAEsB,OAAO,EAAEO,QAAQ,CAAC;EAEjD,OAAOhC,KAAK,CAACiC,GAAG,CAACjB,IAAI,CAACD,QAAQ,EAAE;IAAE,GAAGQ,KAAK;IAAEpB,OAAO,EAAEmC;EAAU,CAAE,CAAC;EAClE,OAAON,QAAQ;AACjB,CAAC,CAAC,CAACrB,IAAI,CAAClB,MAAM,CAAC0B,EAAE,CAAC,CACnB;AAEH;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,MAAMqB,YAAY,GAAIxB,IAAqB,IAChDvB,MAAM,CAAC4B,SAAS,CAAEC,KAAK,IACrB7B,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,MAAMU,OAAO,GAAGH,KAAK,CAACI,EAAE;EAExB,IAAI7B,MAAM,CAAC4C,MAAM,CAAClB,KAAK,CAAClB,MAAM,CAAC,IAAIkB,KAAK,CAAClB,MAAM,CAACuB,KAAK,CAAC,CAAC,CAAC,KAAKH,OAAO,EAAE,OAAO,CAAC;EAE9E,MAAMO,QAAQ,GAAGT,KAAK,CAAClB,MAAM,CAACuB,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;EAC1C,MAAMc,SAAS,GAAGV,QAAQ,IAAI,CAAC,GAC3BnC,MAAM,CAACS,IAAI,EAA6B,GACxCT,MAAM,CAACuC,IAAI,CAAC,CAACX,OAAO,EAAEO,QAAQ,CAAU,CAAC;EAE7C,OAAOhC,KAAK,CAACiC,GAAG,CAACjB,IAAI,CAACD,QAAQ,EAAE;IAAE,GAAGQ,KAAK;IAAElB,MAAM,EAAEqC;EAAS,CAAE,CAAC;EAChE,OAAOV,QAAQ;AACjB,CAAC,CAAC,CAACrB,IAAI,CAAClB,MAAM,CAAC0B,EAAE,CAAC,CACnB;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAMwB,QAAQ,GAAI3B,IAAqB,IAC5CvB,MAAM,CAACmD,cAAc,CACnBxB,WAAW,CAACJ,IAAI,CAAC,EACjB,MAAMqB,WAAW,CAACrB,IAAI,CAAC,CACxB;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAM6B,SAAS,GAAI7B,IAAqB,IAC7CvB,MAAM,CAACmD,cAAc,CACnBV,YAAY,CAAClB,IAAI,CAAC,EAClB,MAAMwB,YAAY,CAACxB,IAAI,CAAC,CACzB;AAEH;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAM8B,YAAY,GA+CpBA,CAAC,GAAGC,IAAgB,KAAI;EAC3B,IAAIA,IAAI,CAACC,MAAM,KAAK,CAAC,EAAE;IACrB,MAAM,CAACC,MAAM,CAAC,GAAGF,IAAI;IACrB,OAAQ/B,IAAqB,IAC3BvB,MAAM,CAACyD,iBAAiB,CACtB9B,WAAW,CAACJ,IAAI,CAAC,EACjB,MAAMiC,MAAM,EACZ,MAAMZ,WAAW,CAACrB,IAAI,CAAC,CACxB;EACL;EACA,MAAM,CAACA,IAAI,EAAEiC,MAAM,CAAC,GAAGF,IAAI;EAC3B,OAAOtD,MAAM,CAACyD,iBAAiB,CAC7B9B,WAAW,CAACJ,IAAI,CAAC,EACjB,MAAMiC,MAAM,EACZ,MAAMZ,WAAW,CAACrB,IAAI,CAAC,CACxB;AACH,CAAS;AAET;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAMmC,aAAa,GA+CrBA,CAAC,GAAGJ,IAAgB,KAAI;EAC3B,IAAIA,IAAI,CAACC,MAAM,KAAK,CAAC,EAAE;IACrB,MAAM,CAACC,MAAM,CAAC,GAAGF,IAAI;IACrB,OAAQ/B,IAAqB,IAC3BvB,MAAM,CAACyD,iBAAiB,CACtBhB,YAAY,CAAClB,IAAI,CAAC,EAClB,MAAMiC,MAAM,EACZ,MAAMT,YAAY,CAACxB,IAAI,CAAC,CACzB;EACL;EACA,MAAM,CAACA,IAAI,EAAEiC,MAAM,CAAC,GAAGF,IAAI;EAC3B,OAAOtD,MAAM,CAACyD,iBAAiB,CAC7BhB,YAAY,CAAClB,IAAI,CAAC,EAClB,MAAMiC,MAAM,EACZ,MAAMT,YAAY,CAACxB,IAAI,CAAC,CACzB;AACH,CAAS;AAET;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,MAAMoC,QAAQ,GA6CjBD,aAAa;AAEjB;AACA;AACA;AAEA;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,MAAME,SAAS,GAAIrC,IAAqB,IAC7CvB,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,IAAIuC,KAAK,GAAG,CAAC;EACb,KAAK,MAAM,GAAGC,KAAK,CAAC,IAAIhC,KAAK,CAACpB,OAAO,EAAE;IACrCmD,KAAK,IAAIC,KAAK;EAChB;EACA,OAAOD,KAAK;AACd,CAAC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAME,UAAU,GAAIxC,IAAqB,IAC9CvB,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,OAAOlB,MAAM,CAAC8B,MAAM,CAACJ,KAAK,CAAClB,MAAM,CAAC,GAAGkB,KAAK,CAAClB,MAAM,CAACuB,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;AAChE,CAAC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAM6B,MAAM,GAAIzC,IAAqB,IAC1CvB,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,OAAOrB,OAAO,CAACgE,IAAI,CAACnC,KAAK,CAACpB,OAAO,CAAC,GAAG,CAAC,IAAIN,MAAM,CAAC8B,MAAM,CAACJ,KAAK,CAAClB,MAAM,CAAC;AACvE,CAAC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMsD,UAAU,GAAI3C,IAAqB,IAC9CvB,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,OAAOrB,OAAO,CAACgE,IAAI,CAACnC,KAAK,CAACpB,OAAO,CAAC,GAAG,CAAC;AACxC,CAAC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMyD,WAAW,GAAI5C,IAAqB,IAC/CvB,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,OAAOlB,MAAM,CAAC8B,MAAM,CAACJ,KAAK,CAAClB,MAAM,CAAC;AACpC,CAAC,CAAC;AAEJ;AACA;AACA;AAEA;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMwD,iBAAiB,GAAIC,CAAU,IAA2B/D,WAAW,CAAC+D,CAAC,EAAE7D,MAAM,CAAC","ignoreList":[]}
+{"version":3,"file":"TxReentrantLock.js","names":["Effect","HashMap","NodeInspectSymbol","toJson","Option","pipeArguments","hasProperty","TxRef","TypeId","emptyState","readers","empty","writer","none","TxReentrantLockProto","toJSON","_id","toString","pipe","arguments","make","gen","stateRef","self","Object","create","tx","acquireRead","withFiber","fiber","state","get","fiberId","id","isSome","value","txRetry","currentCount","getOrElse","newCount","set","acquireWrite","readerId","some","releaseRead","newReaders","remove","releaseWrite","isNone","newWriter","readLock","acquireRelease","writeLock","withReadLock","args","length","effect","acquireUseRelease","withWriteLock","withLock","readLocks","total","count","writeLocks","locked","size","readLocked","writeLocked","isTxReentrantLock","u"],"sources":["../src/TxReentrantLock.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,OAAO,KAAKA,MAAM,MAAM,aAAa;AACrC,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC,SAASC,iBAAiB,EAAEC,MAAM,QAAQ,kBAAkB;AAC5D,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC,SAASC,aAAa,QAAQ,eAAe;AAC7C,SAASC,WAAW,QAAQ,gBAAgB;AAE5C,OAAO,KAAKC,KAAK,MAAM,YAAY;AAEnC,MAAMC,MAAM,GAAG,sCAAsC;AAWrD,MAAMC,UAAU,GAAc;EAC5BC,OAAO,eAAET,OAAO,CAACU,KAAK,EAAkB;EACxCC,MAAM,eAAER,MAAM,CAACS,IAAI;CACpB;AAgCD,MAAMC,oBAAoB,GAAsD;EAC9E,CAACZ,iBAAiB,IAAC;IACjB,OAAOC,MAAM,CAAC,IAAI,CAAC;EACrB,CAAC;EACDY,MAAMA,CAAA;IACJ,OAAO;MAAEC,GAAG,EAAE;IAAiB,CAAE;EACnC,CAAC;EACDC,QAAQA,CAAA;IACN,OAAO,iBAAiB;EAC1B,CAAC;EACDC,IAAIA,CAAA;IACF,OAAOb,aAAa,CAAC,IAAI,EAAEc,SAAS,CAAC;EACvC;CACD;AAED;AACA;AACA;AAEA;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMC,IAAI,GAAGA,CAAA,KAClBpB,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMC,QAAQ,GAAG,OAAOf,KAAK,CAACa,IAAI,CAAYX,UAAU,CAAC;EACzD,MAAMc,IAAI,GAAGC,MAAM,CAACC,MAAM,CAACX,oBAAoB,CAAC;EAChDS,IAAI,CAACf,MAAM,CAAC,GAAGA,MAAM;EACrBe,IAAI,CAACD,QAAQ,GAAGA,QAAQ;EACxB,OAAOC,IAAI;AACb,CAAC,CAAC,CAACL,IAAI,CAAClB,MAAM,CAAC0B,EAAE,CAAC;AAEpB;AACA;AACA;AAEA;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,MAAMC,WAAW,GAAIJ,IAAqB,IAC/CvB,MAAM,CAAC4B,SAAS,CAAEC,KAAK,IACrB7B,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,MAAMU,OAAO,GAAGH,KAAK,CAACI,EAAE;EAExB;EACA,IAAI7B,MAAM,CAAC8B,MAAM,CAACJ,KAAK,CAAClB,MAAM,CAAC,IAAIkB,KAAK,CAAClB,MAAM,CAACuB,KAAK,CAAC,CAAC,CAAC,KAAKH,OAAO,EAAE;IACpE,OAAO,OAAOhC,MAAM,CAACoC,OAAO;EAC9B;EAEA;EACA,MAAMC,YAAY,GAAGjC,MAAM,CAACkC,SAAS,CAACrC,OAAO,CAAC8B,GAAG,CAACD,KAAK,CAACpB,OAAO,EAAEsB,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;EACnF,MAAMO,QAAQ,GAAGF,YAAY,GAAG,CAAC;EACjC,OAAO9B,KAAK,CAACiC,GAAG,CAACjB,IAAI,CAACD,QAAQ,EAAE;IAC9B,GAAGQ,KAAK;IACRpB,OAAO,EAAET,OAAO,CAACuC,GAAG,CAACV,KAAK,CAACpB,OAAO,EAAEsB,OAAO,EAAEO,QAAQ;GACtD,CAAC;EACF,OAAOA,QAAQ;AACjB,CAAC,CAAC,CAACrB,IAAI,CAAClB,MAAM,CAAC0B,EAAE,CAAC,CACnB;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCA,OAAO,MAAMe,YAAY,GAAIlB,IAAqB,IAChDvB,MAAM,CAAC4B,SAAS,CAAEC,KAAK,IACrB7B,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,MAAMU,OAAO,GAAGH,KAAK,CAACI,EAAE;EAExB;EACA,IAAI7B,MAAM,CAAC8B,MAAM,CAACJ,KAAK,CAAClB,MAAM,CAAC,IAAIkB,KAAK,CAAClB,MAAM,CAACuB,KAAK,CAAC,CAAC,CAAC,KAAKH,OAAO,EAAE;IACpE,OAAO,OAAOhC,MAAM,CAACoC,OAAO;EAC9B;EAEA;EACA,KAAK,MAAM,CAACM,QAAQ,CAAC,IAAIZ,KAAK,CAACpB,OAAO,EAAE;IACtC,IAAIgC,QAAQ,KAAKV,OAAO,IAAI5B,MAAM,CAACkC,SAAS,CAACrC,OAAO,CAAC8B,GAAG,CAACD,KAAK,CAACpB,OAAO,EAAEgC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE;MAC/F,OAAO,OAAO1C,MAAM,CAACoC,OAAO;IAC9B;EACF;EAEA;EACA,IAAIhC,MAAM,CAAC8B,MAAM,CAACJ,KAAK,CAAClB,MAAM,CAAC,EAAE;IAC/B;IACA,MAAM2B,QAAQ,GAAGT,KAAK,CAAClB,MAAM,CAACuB,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;IAC1C,OAAO5B,KAAK,CAACiC,GAAG,CAACjB,IAAI,CAACD,QAAQ,EAAE;MAC9B,GAAGQ,KAAK;MACRlB,MAAM,EAAER,MAAM,CAACuC,IAAI,CAAC,CAACX,OAAO,EAAEO,QAAQ,CAAU;KACjD,CAAC;IACF,OAAOA,QAAQ;EACjB;EAEA;EACA,OAAOhC,KAAK,CAACiC,GAAG,CAACjB,IAAI,CAACD,QAAQ,EAAE;IAC9B,GAAGQ,KAAK;IACRlB,MAAM,EAAER,MAAM,CAACuC,IAAI,CAAC,CAACX,OAAO,EAAE,CAAC,CAAU;GAC1C,CAAC;EACF,OAAO,CAAC;AACV,CAAC,CAAC,CAACd,IAAI,CAAClB,MAAM,CAAC0B,EAAE,CAAC,CACnB;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,MAAMkB,WAAW,GAAIrB,IAAqB,IAC/CvB,MAAM,CAAC4B,SAAS,CAAEC,KAAK,IACrB7B,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,MAAMU,OAAO,GAAGH,KAAK,CAACI,EAAE;EACxB,MAAMI,YAAY,GAAGjC,MAAM,CAACkC,SAAS,CAACrC,OAAO,CAAC8B,GAAG,CAACD,KAAK,CAACpB,OAAO,EAAEsB,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;EAEnF,IAAIK,YAAY,IAAI,CAAC,EAAE,OAAO,CAAC;EAE/B,MAAME,QAAQ,GAAGF,YAAY,GAAG,CAAC;EACjC,MAAMQ,UAAU,GAAGN,QAAQ,KAAK,CAAC,GAC7BtC,OAAO,CAAC6C,MAAM,CAAChB,KAAK,CAACpB,OAAO,EAAEsB,OAAO,CAAC,GACtC/B,OAAO,CAACuC,GAAG,CAACV,KAAK,CAACpB,OAAO,EAAEsB,OAAO,EAAEO,QAAQ,CAAC;EAEjD,OAAOhC,KAAK,CAACiC,GAAG,CAACjB,IAAI,CAACD,QAAQ,EAAE;IAAE,GAAGQ,KAAK;IAAEpB,OAAO,EAAEmC;EAAU,CAAE,CAAC;EAClE,OAAON,QAAQ;AACjB,CAAC,CAAC,CAACrB,IAAI,CAAClB,MAAM,CAAC0B,EAAE,CAAC,CACnB;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,MAAMqB,YAAY,GAAIxB,IAAqB,IAChDvB,MAAM,CAAC4B,SAAS,CAAEC,KAAK,IACrB7B,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,MAAMU,OAAO,GAAGH,KAAK,CAACI,EAAE;EAExB,IAAI7B,MAAM,CAAC4C,MAAM,CAAClB,KAAK,CAAClB,MAAM,CAAC,IAAIkB,KAAK,CAAClB,MAAM,CAACuB,KAAK,CAAC,CAAC,CAAC,KAAKH,OAAO,EAAE,OAAO,CAAC;EAE9E,MAAMO,QAAQ,GAAGT,KAAK,CAAClB,MAAM,CAACuB,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;EAC1C,MAAMc,SAAS,GAAGV,QAAQ,IAAI,CAAC,GAC3BnC,MAAM,CAACS,IAAI,EAA6B,GACxCT,MAAM,CAACuC,IAAI,CAAC,CAACX,OAAO,EAAEO,QAAQ,CAAU,CAAC;EAE7C,OAAOhC,KAAK,CAACiC,GAAG,CAACjB,IAAI,CAACD,QAAQ,EAAE;IAAE,GAAGQ,KAAK;IAAElB,MAAM,EAAEqC;EAAS,CAAE,CAAC;EAChE,OAAOV,QAAQ;AACjB,CAAC,CAAC,CAACrB,IAAI,CAAClB,MAAM,CAAC0B,EAAE,CAAC,CACnB;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAMwB,QAAQ,GAAI3B,IAAqB,IAC5CvB,MAAM,CAACmD,cAAc,CACnBxB,WAAW,CAACJ,IAAI,CAAC,EACjB,MAAMqB,WAAW,CAACrB,IAAI,CAAC,CACxB;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAM6B,SAAS,GAAI7B,IAAqB,IAC7CvB,MAAM,CAACmD,cAAc,CACnBV,YAAY,CAAClB,IAAI,CAAC,EAClB,MAAMwB,YAAY,CAACxB,IAAI,CAAC,CACzB;AAEH;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAM8B,YAAY,GA+CpBA,CAAC,GAAGC,IAAgB,KAAI;EAC3B,IAAIA,IAAI,CAACC,MAAM,KAAK,CAAC,EAAE;IACrB,MAAM,CAACC,MAAM,CAAC,GAAGF,IAAI;IACrB,OAAQ/B,IAAqB,IAC3BvB,MAAM,CAACyD,iBAAiB,CACtB9B,WAAW,CAACJ,IAAI,CAAC,EACjB,MAAMiC,MAAM,EACZ,MAAMZ,WAAW,CAACrB,IAAI,CAAC,CACxB;EACL;EACA,MAAM,CAACA,IAAI,EAAEiC,MAAM,CAAC,GAAGF,IAAI;EAC3B,OAAOtD,MAAM,CAACyD,iBAAiB,CAC7B9B,WAAW,CAACJ,IAAI,CAAC,EACjB,MAAMiC,MAAM,EACZ,MAAMZ,WAAW,CAACrB,IAAI,CAAC,CACxB;AACH,CAAS;AAET;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAMmC,aAAa,GA+CrBA,CAAC,GAAGJ,IAAgB,KAAI;EAC3B,IAAIA,IAAI,CAACC,MAAM,KAAK,CAAC,EAAE;IACrB,MAAM,CAACC,MAAM,CAAC,GAAGF,IAAI;IACrB,OAAQ/B,IAAqB,IAC3BvB,MAAM,CAACyD,iBAAiB,CACtBhB,YAAY,CAAClB,IAAI,CAAC,EAClB,MAAMiC,MAAM,EACZ,MAAMT,YAAY,CAACxB,IAAI,CAAC,CACzB;EACL;EACA,MAAM,CAACA,IAAI,EAAEiC,MAAM,CAAC,GAAGF,IAAI;EAC3B,OAAOtD,MAAM,CAACyD,iBAAiB,CAC7BhB,YAAY,CAAClB,IAAI,CAAC,EAClB,MAAMiC,MAAM,EACZ,MAAMT,YAAY,CAACxB,IAAI,CAAC,CACzB;AACH,CAAS;AAET;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAMoC,QAAQ,GAqDjBD,aAAa;AAEjB;AACA;AACA;AAEA;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,MAAME,SAAS,GAAIrC,IAAqB,IAC7CvB,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,IAAIuC,KAAK,GAAG,CAAC;EACb,KAAK,MAAM,GAAGC,KAAK,CAAC,IAAIhC,KAAK,CAACpB,OAAO,EAAE;IACrCmD,KAAK,IAAIC,KAAK;EAChB;EACA,OAAOD,KAAK;AACd,CAAC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAME,UAAU,GAAIxC,IAAqB,IAC9CvB,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,OAAOlB,MAAM,CAAC8B,MAAM,CAACJ,KAAK,CAAClB,MAAM,CAAC,GAAGkB,KAAK,CAAClB,MAAM,CAACuB,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;AAChE,CAAC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAM6B,MAAM,GAAIzC,IAAqB,IAC1CvB,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,OAAOrB,OAAO,CAACgE,IAAI,CAACnC,KAAK,CAACpB,OAAO,CAAC,GAAG,CAAC,IAAIN,MAAM,CAAC8B,MAAM,CAACJ,KAAK,CAAClB,MAAM,CAAC;AACvE,CAAC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMsD,UAAU,GAAI3C,IAAqB,IAC9CvB,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,OAAOrB,OAAO,CAACgE,IAAI,CAACnC,KAAK,CAACpB,OAAO,CAAC,GAAG,CAAC;AACxC,CAAC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMyD,WAAW,GAAI5C,IAAqB,IAC/CvB,MAAM,CAACqB,GAAG,CAAC,aAAS;EAClB,MAAMS,KAAK,GAAG,OAAOvB,KAAK,CAACwB,GAAG,CAACR,IAAI,CAACD,QAAQ,CAAC;EAC7C,OAAOlB,MAAM,CAAC8B,MAAM,CAACJ,KAAK,CAAClB,MAAM,CAAC;AACpC,CAAC,CAAC;AAEJ;AACA;AACA;AAEA;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMwD,iBAAiB,GAAIC,CAAU,IAA2B/D,WAAW,CAAC+D,CAAC,EAAE7D,MAAM,CAAC","ignoreList":[]}

package/dist/TxRef.d.ts

@@ -1,10 +1,63 @@
 /**
- * TxRef is a transactional value, it can be read and modified within the body of a transaction.
+ * The `TxRef` module provides transactional references for coordinating mutable
+ * state with Effect transactions. A `TxRef<A>` stores a current value, but
+ * reads and writes inside `Effect.tx` are recorded in a transaction journal and
+ * committed together only when the outermost transaction succeeds.
  *
- * Accessed values are tracked by the transaction in order to detect conflicts and in order to
- * track changes, a transaction will retry whenever a conflict is detected or whenever the
- * transaction explicitely calls to `Effect.txRetry` and any of the accessed TxRef values
- * change.
+ * **Mental model**
+ *
+ * - {@link make} creates a reference whose value can participate in
+ *   optimistic transactions.
+ * - {@link get}, {@link set}, {@link update}, and {@link modify} read and
+ *   write the transaction journal when a transaction is active.
+ * - At commit time, the transaction checks whether any accessed reference was
+ *   changed by another transaction. If so, it retries with a fresh journal.
+ * - `Effect.txRetry` suspends the transaction until one of the `TxRef` values
+ *   read by the transaction changes.
+ *
+ * **Common tasks**
+ *
+ * - Create transactional state with {@link make}.
+ * - Read the current value with {@link get}.
+ * - Replace or transform the value with {@link set} and {@link update}.
+ * - Return a derived result while writing a new value with {@link modify}.
+ * - Wrap related reads and writes in one `Effect.tx` boundary so they commit or
+ *   roll back as a unit.
+ *
+ * **Example** (Committing multiple updates atomically)
+ *
+ * ```ts
+ * import { Effect, TxRef } from "effect"
+ *
+ * const transfer = Effect.gen(function*() {
+ *   const checking = yield* TxRef.make(100)
+ *   const savings = yield* TxRef.make(0)
+ *
+ *   yield* Effect.tx(Effect.gen(function*() {
+ *     const balance = yield* TxRef.get(checking)
+ *     if (balance < 30) {
+ *       return yield* Effect.fail("insufficient funds")
+ *     }
+ *     yield* TxRef.set(checking, balance - 30)
+ *     yield* TxRef.update(savings, (amount) => amount + 30)
+ *   }))
+ *
+ *   return {
+ *     checking: yield* TxRef.get(checking),
+ *     savings: yield* TxRef.get(savings)
+ *   }
+ * })
+ * ```
+ *
+ * **Gotchas**
+ *
+ * - Group related operations in the same `Effect.tx` call; separate
+ *   transactions can observe and commit intermediate states.
+ * - A transaction body can run more than once after a conflict or
+ *   `Effect.txRetry`, so keep externally visible effects outside the
+ *   transaction body or make them idempotent.
+ * - If a transaction fails, its journal is discarded and other fibers continue
+ *   to see the last committed values.
  *
  * @since 4.0.0
  */
@@ -15,6 +68,11 @@ declare const TypeId = "~effect/transactions/TxRef";
 /**
  * TxRef is a transactional value, it can be read and modified within the body of a transaction.
  *
+ * **When to use**
+ *
+ * Use to store mutable state that must be read and modified inside Effect
+ * transactions.
+ *
  * **Details**
  *
  * Accessed values are tracked by the transaction in order to detect conflicts and in order to
@@ -54,6 +112,10 @@ export interface TxRef<in out A> extends Pipeable {
 /**
  * Creates a new `TxRef` with the specified initial value.
  *
+ * **When to use**
+ *
+ * Use to create a transactional reference inside an `Effect` workflow.
+ *
  * **Example** (Creating transactional references)
  *
  * ```ts
@@ -80,12 +142,12 @@ export interface TxRef<in out A> extends Pipeable {
  */
 export declare const make: <A>(initial: A) => Effect.Effect<TxRef<A>, never, never>;
 /**
- * Synchronously creates a new `TxRef` with the specified initial value.
+ * Creates a new `TxRef` synchronously with the specified initial value.
  *
  * **When to use**
  *
- * Prefer `make` in Effect code so allocation stays inside the Effect workflow.
- * Use `makeUnsafe` only when a `TxRef` must be constructed outside an effect.
+ * Use to construct a transactional reference synchronously when it must be
+ * created outside an `Effect` workflow.
  *
  * **Example** (Creating transactional references unsafely)
  *
@@ -108,6 +170,11 @@ export declare const makeUnsafe: <A>(initial: A) => TxRef<A>;
 /**
  * Modifies the value of the `TxRef` using the provided function.
  *
+ * **When to use**
+ *
+ * Use to update a transactional reference and return a computed result from the
+ * same transaction step.
+ *
  * **Example** (Modifying transactional references)
  *
  * ```ts
@@ -131,6 +198,11 @@ export declare const modify: {
     /**
      * Modifies the value of the `TxRef` using the provided function.
      *
+     * **When to use**
+     *
+     * Use to update a transactional reference and return a computed result from the
+     * same transaction step.
+     *
      * **Example** (Modifying transactional references)
      *
      * ```ts
@@ -154,6 +226,11 @@ export declare const modify: {
     /**
      * Modifies the value of the `TxRef` using the provided function.
      *
+     * **When to use**
+     *
+     * Use to update a transactional reference and return a computed result from the
+     * same transaction step.
+     *
      * **Example** (Modifying transactional references)
      *
      * ```ts
@@ -178,6 +255,10 @@ export declare const modify: {
 /**
  * Updates the value of the `TxRef` using the provided function.
  *
+ * **When to use**
+ *
+ * Use to transform a transactional reference when no result value is needed.
+ *
  * **Example** (Updating transactional references)
  *
  * ```ts
@@ -202,6 +283,10 @@ export declare const update: {
     /**
      * Updates the value of the `TxRef` using the provided function.
      *
+     * **When to use**
+     *
+     * Use to transform a transactional reference when no result value is needed.
+     *
      * **Example** (Updating transactional references)
      *
      * ```ts
@@ -226,6 +311,10 @@ export declare const update: {
     /**
      * Updates the value of the `TxRef` using the provided function.
      *
+     * **When to use**
+     *
+     * Use to transform a transactional reference when no result value is needed.
+     *
      * **Example** (Updating transactional references)
      *
      * ```ts
@@ -251,6 +340,10 @@ export declare const update: {
 /**
  * Reads the current value of the `TxRef`.
  *
+ * **When to use**
+ *
+ * Use to read the current value of a transactional reference.
+ *
  * **Example** (Reading transactional references)
  *
  * ```ts
@@ -275,6 +368,10 @@ export declare const get: <A>(self: TxRef<A>) => Effect.Effect<A>;
 /**
  * Sets the value of the `TxRef`.
  *
+ * **When to use**
+ *
+ * Use to replace the value of a transactional reference.
+ *
  * **Example** (Setting transactional references)
  *
  * ```ts
@@ -299,6 +396,10 @@ export declare const set: {
     /**
      * Sets the value of the `TxRef`.
      *
+     * **When to use**
+     *
+     * Use to replace the value of a transactional reference.
+     *
      * **Example** (Setting transactional references)
      *
      * ```ts
@@ -323,6 +424,10 @@ export declare const set: {
     /**
      * Sets the value of the `TxRef`.
      *
+     * **When to use**
+     *
+     * Use to replace the value of a transactional reference.
+     *
      * **Example** (Setting transactional references)
      *
      * ```ts

package/dist/TxRef.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TxRef.d.ts","sourceRoot":"","sources":["../src/TxRef.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAGrC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEzC,QAAA,MAAM,MAAM,+BAA+B,CAAA;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,QAAQ;IAC/C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAEhC,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC,CAAA;IACjC,KAAK,EAAE,CAAC,CAAA;CACT;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,SAAS,CAAC,0CAA2C,CAAA;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,SAAS,CAAC,KAAG,KAAK,CAAC,CAAC,CAQhD,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACvG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAkBxF,CAAA;AAEJ;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC3E;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAIU,CAAA;AAE1E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,MAAM,KAAK,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAkD,CAAA;AAEzG;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACtD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAIA,CAAA"}
+{"version":3,"file":"TxRef.d.ts","sourceRoot":"","sources":["../src/TxRef.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAGrC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEzC,QAAA,MAAM,MAAM,+BAA+B,CAAA;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,WAAW,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,QAAQ;IAC/C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAEhC,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC,CAAA;IACjC,KAAK,EAAE,CAAC,CAAA;CACT;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,SAAS,CAAC,0CAA2C,CAAA;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,SAAS,CAAC,KAAG,KAAK,CAAC,CAAC,CAQhD,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACvG;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAkBxF,CAAA;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC3E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAIU,CAAA;AAE1E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,MAAM,KAAK,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAkD,CAAA;AAEzG;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IACtD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAIA,CAAA"}