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

package/dist/TxHashSet.d.ts

@@ -225,7 +225,7 @@ export declare const fromIterable: <V>(values: Iterable<V>) => Effect.Effect<TxH
  */
 export declare const fromHashSet: <V>(hashSet: HashSet.HashSet<V>) => Effect.Effect<TxHashSet<V>>;
 /**
- * Checks if a value is a TxHashSet.
+ * Checks whether a value is a TxHashSet.
  *
  * **Example** (Checking for a TxHashSet)
  *
@@ -428,7 +428,7 @@ export declare const remove: {
     <V>(self: TxHashSet<V>, value: V): Effect.Effect<boolean>;
 };
 /**
- * Checks if the TxHashSet contains the specified value.
+ * Checks whether the TxHashSet contains the specified value.
  *
  * **Example** (Checking membership)
  *
@@ -464,7 +464,7 @@ export declare const remove: {
  */
 export declare const has: {
     /**
-     * Checks if the TxHashSet contains the specified value.
+     * Checks whether the TxHashSet contains the specified value.
      *
      * **Example** (Checking membership)
      *
@@ -500,7 +500,7 @@ export declare const has: {
      */
     <V>(value: V): (self: TxHashSet<V>) => Effect.Effect<boolean>;
     /**
-     * Checks if the TxHashSet contains the specified value.
+     * Checks whether the TxHashSet contains the specified value.
      *
      * **Example** (Checking membership)
      *
@@ -561,7 +561,7 @@ export declare const has: {
  */
 export declare const size: <V>(self: TxHashSet<V>) => Effect.Effect<number>;
 /**
- * Checks if the TxHashSet is empty.
+ * Checks whether the TxHashSet is empty.
  *
  * **Example** (Checking whether a set is empty)
  *
@@ -818,7 +818,7 @@ export declare const difference: {
     <V0, V1>(self: TxHashSet<V0>, that: TxHashSet<V1>): Effect.Effect<TxHashSet<V0>>;
 };
 /**
- * Checks if a TxHashSet is a subset of another TxHashSet.
+ * Checks whether a TxHashSet is a subset of another TxHashSet.
  *
  * **Example** (Checking subset relationships)
  *
@@ -842,7 +842,7 @@ export declare const difference: {
  */
 export declare const isSubset: {
     /**
-     * Checks if a TxHashSet is a subset of another TxHashSet.
+     * Checks whether a TxHashSet is a subset of another TxHashSet.
      *
      * **Example** (Checking subset relationships)
      *
@@ -866,7 +866,7 @@ export declare const isSubset: {
      */
     <V1>(that: TxHashSet<V1>): <V0>(self: TxHashSet<V0>) => Effect.Effect<boolean>;
     /**
-     * Checks if a TxHashSet is a subset of another TxHashSet.
+     * Checks whether a TxHashSet is a subset of another TxHashSet.
      *
      * **Example** (Checking subset relationships)
      *
@@ -891,7 +891,7 @@ export declare const isSubset: {
     <V0, V1>(self: TxHashSet<V0>, that: TxHashSet<V1>): Effect.Effect<boolean>;
 };
 /**
- * Tests whether at least one value in the TxHashSet satisfies the predicate.
+ * Checks whether at least one value in the TxHashSet satisfies the predicate.
  *
  * **Example** (Testing whether some values match)
  *
@@ -914,7 +914,7 @@ export declare const isSubset: {
  */
 export declare const some: {
     /**
-     * Tests whether at least one value in the TxHashSet satisfies the predicate.
+     * Checks whether at least one value in the TxHashSet satisfies the predicate.
      *
      * **Example** (Testing whether some values match)
      *
@@ -937,7 +937,7 @@ export declare const some: {
      */
     <V>(predicate: Predicate<V>): (self: TxHashSet<V>) => Effect.Effect<boolean>;
     /**
-     * Tests whether at least one value in the TxHashSet satisfies the predicate.
+     * Checks whether at least one value in the TxHashSet satisfies the predicate.
      *
      * **Example** (Testing whether some values match)
      *
@@ -961,7 +961,7 @@ export declare const some: {
     <V>(self: TxHashSet<V>, predicate: Predicate<V>): Effect.Effect<boolean>;
 };
 /**
- * Tests whether all values in the TxHashSet satisfy the predicate.
+ * Checks whether all values in the TxHashSet satisfy the predicate.
  *
  * **Example** (Testing whether every value matches)
  *
@@ -984,7 +984,7 @@ export declare const some: {
  */
 export declare const every: {
     /**
-     * Tests whether all values in the TxHashSet satisfy the predicate.
+     * Checks whether all values in the TxHashSet satisfy the predicate.
      *
      * **Example** (Testing whether every value matches)
      *
@@ -1007,7 +1007,7 @@ export declare const every: {
      */
     <V>(predicate: Predicate<V>): (self: TxHashSet<V>) => Effect.Effect<boolean>;
     /**
-     * Tests whether all values in the TxHashSet satisfy the predicate.
+     * Checks whether all values in the TxHashSet satisfy the predicate.
      *
      * **Example** (Testing whether every value matches)
      *

package/dist/TxHashSet.js

@@ -168,7 +168,7 @@ export const fromHashSet = hashSet => Effect.gen(function* () {
   return makeTxHashSet(ref);
 });
 /**
- * Checks if a value is a TxHashSet.
+ * Checks whether a value is a TxHashSet.
  *
  * **Example** (Checking for a TxHashSet)
  *
@@ -258,7 +258,7 @@ export const remove = /*#__PURE__*/dual(2, (self, value) => Effect.gen(function*
   return existed;
 }).pipe(Effect.tx));
 /**
- * Checks if the TxHashSet contains the specified value.
+ * Checks whether the TxHashSet contains the specified value.
  *
  * **Example** (Checking membership)
  *
@@ -324,7 +324,7 @@ export const size = self => Effect.gen(function* () {
   return HashSet.size(set);
 });
 /**
- * Checks if the TxHashSet is empty.
+ * Checks whether the TxHashSet is empty.
  *
  * **Example** (Checking whether a set is empty)
  *
@@ -458,7 +458,7 @@ export const difference = /*#__PURE__*/dual(2, (self, that) => Effect.gen(functi
   return yield* fromHashSet(diff);
 }).pipe(Effect.tx));
 /**
- * Checks if a TxHashSet is a subset of another TxHashSet.
+ * Checks whether a TxHashSet is a subset of another TxHashSet.
  *
  * **Example** (Checking subset relationships)
  *
@@ -486,7 +486,7 @@ export const isSubset = /*#__PURE__*/dual(2, (self, that) => Effect.gen(function
   return HashSet.isSubset(set1, set2);
 }).pipe(Effect.tx));
 /**
- * Tests whether at least one value in the TxHashSet satisfies the predicate.
+ * Checks whether at least one value in the TxHashSet satisfies the predicate.
  *
  * **Example** (Testing whether some values match)
  *
@@ -512,7 +512,7 @@ export const some = /*#__PURE__*/dual(2, (self, predicate) => Effect.gen(functio
   return HashSet.some(set, predicate);
 }));
 /**
- * Tests whether all values in the TxHashSet satisfy the predicate.
+ * Checks whether all values in the TxHashSet satisfy the predicate.
  *
  * **Example** (Testing whether every value matches)
  *

package/dist/TxPriorityQueue.d.ts

@@ -1,6 +1,33 @@
 /**
- * A transactional priority queue. Elements are dequeued in order determined by the
- * provided `Order` instance. All operations participate in the STM transaction system.
+ * The `TxPriorityQueue` module provides a mutable priority queue whose state is
+ * stored in a transactional reference. Elements are kept in the order defined by
+ * the `Order` supplied at construction time, and dequeue operations return the
+ * first element according to that ordering.
+ *
+ * A `TxPriorityQueue<A>` is useful when multiple fibers coordinate through a
+ * shared queue and the queue operation needs to compose with other
+ * transactional state changes. Every operation returns an `Effect`; group
+ * several queue operations with `Effect.tx` when the whole sequence must commit
+ * or retry as one transaction.
+ *
+ * **Common tasks**
+ *
+ * - Create queues with {@link empty}, {@link fromIterable}, or {@link make}
+ * - Insert values with {@link offer} and {@link offerAll}
+ * - Read priority order with {@link peek}, {@link peekOption}, and
+ *   {@link toArray}
+ * - Remove values with {@link take}, {@link takeOption}, {@link takeAll}, and
+ *   {@link takeUpTo}
+ * - Keep or remove subsets with {@link retainIf} and {@link removeIf}
+ *
+ * **Gotchas**
+ *
+ * - `take` and `peek` retry when the queue is empty; use `takeOption` or
+ *   `peekOption` when empty queues should be represented as `Option.none`.
+ * - `Order.Number` is ascending, so lower numbers are dequeued first. Provide a
+ *   reversed order when larger values should have higher priority.
+ * - The queue preserves all values with equal priority; equal values are not
+ *   merged or deduplicated.
  *
  * @since 4.0.0
  */
@@ -199,8 +226,12 @@ export declare const isEmpty: <A>(self: TxPriorityQueue<A>) => Effect.Effect<boo
  */
 export declare const isNonEmpty: <A>(self: TxPriorityQueue<A>) => Effect.Effect<boolean>;
 /**
- * Observes the smallest element without removing it. Retries if the queue is
- * empty.
+ * Observes the smallest element without removing it.
+ *
+ * **When to use**
+ *
+ * Use to inspect the next prioritized value and retry transactionally while
+ * the queue is empty.
  *
  * **Example** (Peeking at the next value)
  *
@@ -219,9 +250,13 @@ export declare const isNonEmpty: <A>(self: TxPriorityQueue<A>) => Effect.Effect<
  */
 export declare const peek: <A>(self: TxPriorityQueue<A>) => Effect.Effect<A>;
 /**
- * Observes the smallest element without removing it. Returns `None` if the
+ * Observes the smallest element without removing it, returning `None` when the
  * queue is empty.
  *
+ * **When to use**
+ *
+ * Use to inspect the next prioritized value without retrying on an empty queue.
+ *
  * **Example** (Peeking without retrying)
  *
  * ```ts
@@ -540,7 +575,7 @@ export declare const removeIf: {
     <A>(self: TxPriorityQueue<A>, predicate: Predicate<A>): Effect.Effect<void>;
 };
 /**
- * Retains only elements matching the predicate.
+ * Keeps only elements matching the predicate.
  *
  * **Example** (Retaining matching values)
  *
@@ -560,7 +595,7 @@ export declare const removeIf: {
  */
 export declare const retainIf: {
     /**
-     * Retains only elements matching the predicate.
+     * Keeps only elements matching the predicate.
      *
      * **Example** (Retaining matching values)
      *
@@ -580,7 +615,7 @@ export declare const retainIf: {
      */
     <A>(predicate: Predicate<A>): (self: TxPriorityQueue<A>) => Effect.Effect<void>;
     /**
-     * Retains only elements matching the predicate.
+     * Keeps only elements matching the predicate.
      *
      * **Example** (Retaining matching values)
      *

package/dist/TxPriorityQueue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TxPriorityQueue.d.ts","sourceRoot":"","sources":["../src/TxPriorityQueue.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAEvC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAE7C,OAAO,EAAe,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC,QAAA,MAAM,MAAM,yCAAyC,CAAA;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,eAAe,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,WAAW,EAAE,QAAQ;IACtE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACnC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;CACvB;AA2CD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,KAAK,GAAI,CAAC,EAAE,OAAO,KAAK,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CACY,CAAA;AAEvF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;IAClF;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;CA4B/E,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,GAAG,UAAU,KAAK,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CACtE,CAAA;AAE/B;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAA4C,CAAA;AAEnH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAA2C,CAAA;AAEtH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAyC,CAAA;AAEvH;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAQ9C,CAAA;AAEpB;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CACvC,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,KAAK,EAAE;IAClB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAChE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAK7D,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC3E;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAQxE,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAS9C,CAAA;AAEpB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAIzE,CAAA;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAO5E,CAAA;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACrE;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;CAYlE,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC/E;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAK5E,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC/E;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAK5E,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAChC,CAAA;AAE5C;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,iBAAiB,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,eAAe,CAAC,OAAO,CAA2B,CAAA"}
+{"version":3,"file":"TxPriorityQueue.d.ts","sourceRoot":"","sources":["../src/TxPriorityQueue.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAEvC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAE7C,OAAO,EAAe,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC5D,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC,QAAA,MAAM,MAAM,yCAAyC,CAAA;AAErD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,eAAe,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,WAAW,EAAE,QAAQ;IACtE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACnC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;CACvB;AA2CD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,KAAK,GAAI,CAAC,EAAE,OAAO,KAAK,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CACY,CAAA;AAEvF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;IAClF;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;CA4B/E,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,GAAG,UAAU,KAAK,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CACtE,CAAA;AAE/B;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAA4C,CAAA;AAEnH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAA2C,CAAA;AAEtH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAyC,CAAA;AAEvH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAQ9C,CAAA;AAEpB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CACvC,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,KAAK,EAAE;IAClB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAChE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAK7D,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC3E;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAQxE,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAS9C,CAAA;AAEpB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAIzE,CAAA;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAO5E,CAAA;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IACrE;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;CAYlE,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC/E;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAK5E,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC/E;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAK5E,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,MAAM,eAAe,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAChC,CAAA;AAE5C;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,iBAAiB,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,eAAe,CAAC,OAAO,CAA2B,CAAA"}

package/dist/TxPriorityQueue.js

@@ -1,6 +1,33 @@
 /**
- * A transactional priority queue. Elements are dequeued in order determined by the
- * provided `Order` instance. All operations participate in the STM transaction system.
+ * The `TxPriorityQueue` module provides a mutable priority queue whose state is
+ * stored in a transactional reference. Elements are kept in the order defined by
+ * the `Order` supplied at construction time, and dequeue operations return the
+ * first element according to that ordering.
+ *
+ * A `TxPriorityQueue<A>` is useful when multiple fibers coordinate through a
+ * shared queue and the queue operation needs to compose with other
+ * transactional state changes. Every operation returns an `Effect`; group
+ * several queue operations with `Effect.tx` when the whole sequence must commit
+ * or retry as one transaction.
+ *
+ * **Common tasks**
+ *
+ * - Create queues with {@link empty}, {@link fromIterable}, or {@link make}
+ * - Insert values with {@link offer} and {@link offerAll}
+ * - Read priority order with {@link peek}, {@link peekOption}, and
+ *   {@link toArray}
+ * - Remove values with {@link take}, {@link takeOption}, {@link takeAll}, and
+ *   {@link takeUpTo}
+ * - Keep or remove subsets with {@link retainIf} and {@link removeIf}
+ *
+ * **Gotchas**
+ *
+ * - `take` and `peek` retry when the queue is empty; use `takeOption` or
+ *   `peekOption` when empty queues should be represented as `Option.none`.
+ * - `Order.Number` is ascending, so lower numbers are dequeued first. Provide a
+ *   reversed order when larger values should have higher priority.
+ * - The queue preserves all values with equal priority; equal values are not
+ *   merged or deduplicated.
  *
  * @since 4.0.0
  */
@@ -169,8 +196,12 @@ export const isEmpty = self => Effect.map(size(self), n => n === 0);
  */
 export const isNonEmpty = self => Effect.map(size(self), n => n > 0);
 /**
- * Observes the smallest element without removing it. Retries if the queue is
- * empty.
+ * Observes the smallest element without removing it.
+ *
+ * **When to use**
+ *
+ * Use to inspect the next prioritized value and retry transactionally while
+ * the queue is empty.
  *
  * **Example** (Peeking at the next value)
  *
@@ -196,9 +227,13 @@ export const peek = self => Effect.gen(function* () {
   return head.value;
 }).pipe(Effect.tx);
 /**
- * Observes the smallest element without removing it. Returns `None` if the
+ * Observes the smallest element without removing it, returning `None` when the
  * queue is empty.
  *
+ * **When to use**
+ *
+ * Use to inspect the next prioritized value without retrying on an empty queue.
+ *
  * **Example** (Peeking without retrying)
  *
  * ```ts
@@ -374,7 +409,7 @@ export const takeUpTo = /*#__PURE__*/dual(2, (self, n) => Effect.map(TxRef.modif
  */
 export const removeIf = /*#__PURE__*/dual(2, (self, predicate) => TxRef.update(self.ref, chunk => C.filter(chunk, a => !predicate(a))));
 /**
- * Retains only elements matching the predicate.
+ * Keeps only elements matching the predicate.
  *
  * **Example** (Retaining matching values)
  *

package/dist/TxPriorityQueue.js.map

@@ -1 +1 @@
-{"version":3,"file":"TxPriorityQueue.js","names":["C","Effect","dual","NodeInspectSymbol","toJson","O","pipeArguments","hasProperty","TxRef","TypeId","TxPriorityQueueProto","toJSON","_id","pipe","arguments","makeTxPriorityQueue","ref","ord","self","Object","create","insertSorted","chunk","value","arr","toArray","lo","hi","length","mid","out","Array","i","fromIterable","empty","order","map","make","iterable","from","sort","a","b","elements","size","get","isEmpty","n","isNonEmpty","peek","gen","head","isNone","txRetry","tx","peekOption","offer","update","offerAll","values","take","set","drop","takeAll","modify","takeOption","none","some","takeUpTo","taken","rest","removeIf","predicate","filter","retainIf","isTxPriorityQueue","u"],"sources":["../src/TxPriorityQueue.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;AAQA,OAAO,KAAKA,CAAC,MAAM,YAAY;AAC/B,OAAO,KAAKC,MAAM,MAAM,aAAa;AACrC,SAASC,IAAI,QAAQ,eAAe;AAEpC,SAASC,iBAAiB,EAAEC,MAAM,QAAQ,kBAAkB;AAE5D,OAAO,KAAKC,CAAC,MAAM,aAAa;AAGhC,SAASC,aAAa,QAAQ,eAAe;AAC7C,SAASC,WAAW,QAAwB,gBAAgB;AAC5D,OAAO,KAAKC,KAAK,MAAM,YAAY;AAEnC,MAAMC,MAAM,GAAG,sCAAsC;AAmCrD,MAAMC,oBAAoB,GAAkE;EAC1F,CAACP,iBAAiB,IAAC;IACjB,OAAOC,MAAM,CAAC,IAAI,CAAC;EACrB,CAAC;EACDO,MAAMA,CAAA;IACJ,OAAO;MACLC,GAAG,EAAE;KACN;EACH,CAAC;EACDC,IAAIA,CAAA;IACF,OAAOP,aAAa,CAAC,IAAI,EAAEQ,SAAS,CAAC;EACvC;CACD;AAED,MAAMC,mBAAmB,GAAGA,CAAIC,GAA0B,EAAEC,GAAa,KAAwB;EAC/F,MAAMC,IAAI,GAAGC,MAAM,CAACC,MAAM,CAACV,oBAAoB,CAAC;EAChDQ,IAAI,CAACT,MAAM,CAAC,GAAGA,MAAM;EACrBS,IAAI,CAACF,GAAG,GAAGA,GAAG;EACdE,IAAI,CAACD,GAAG,GAAGA,GAAG;EACd,OAAOC,IAAI;AACb,CAAC;AAED,MAAMG,YAAY,GAAGA,CAAIC,KAAe,EAAEC,KAAQ,EAAEN,GAAa,KAAc;EAC7E,MAAMO,GAAG,GAAGxB,CAAC,CAACyB,OAAO,CAACH,KAAK,CAAa;EACxC,IAAII,EAAE,GAAG,CAAC;EACV,IAAIC,EAAE,GAAGH,GAAG,CAACI,MAAM;EACnB,OAAOF,EAAE,GAAGC,EAAE,EAAE;IACd,MAAME,GAAG,GAAIH,EAAE,GAAGC,EAAE,KAAM,CAAC;IAC3B,IAAIV,GAAG,CAACO,GAAG,CAACK,GAAG,CAAC,EAAEN,KAAK,CAAC,IAAI,CAAC,EAAE;MAC7BG,EAAE,GAAGG,GAAG,GAAG,CAAC;IACd,CAAC,MAAM;MACLF,EAAE,GAAGE,GAAG;IACV;EACF;EACA,MAAMC,GAAG,GAAGC,KAAK,CAACP,GAAG,CAACI,MAAM,GAAG,CAAC,CAAa;EAC7C,KAAK,IAAII,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGN,EAAE,EAAEM,CAAC,EAAE,EAAEF,GAAG,CAACE,CAAC,CAAC,GAAGR,GAAG,CAACQ,CAAC,CAAC;EAC5CF,GAAG,CAACJ,EAAE,CAAC,GAAGH,KAAK;EACf,KAAK,IAAIS,CAAC,GAAGN,EAAE,EAAEM,CAAC,GAAGR,GAAG,CAACI,MAAM,EAAEI,CAAC,EAAE,EAAEF,GAAG,CAACE,CAAC,GAAG,CAAC,CAAC,GAAGR,GAAG,CAACQ,CAAC,CAAC;EACzD,OAAOhC,CAAC,CAACiC,YAAY,CAACH,GAAG,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMI,KAAK,GAAOC,KAAe,IACtClC,MAAM,CAACmC,GAAG,CAAC5B,KAAK,CAAC6B,IAAI,CAAWrC,CAAC,CAACkC,KAAK,EAAE,CAAC,EAAGlB,GAAG,IAAKD,mBAAmB,CAACC,GAAG,EAAEmB,KAAK,CAAC,CAAC;AAEvF;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMF,YAAY,gBAuCrB/B,IAAI,CACN,CAAC,EACD,CAAIiC,KAAe,EAAEG,QAAqB,KAAuC;EAC/E,MAAMd,GAAG,GAAGO,KAAK,CAACQ,IAAI,CAACD,QAAQ,CAAC,CAACE,IAAI,CAAC,CAACC,CAAC,EAAEC,CAAC,KAAKP,KAAK,CAACM,CAAC,EAAEC,CAAC,CAAC,CAAC;EAC5D,OAAOzC,MAAM,CAACmC,GAAG,CACf5B,KAAK,CAAC6B,IAAI,CAkBArC,CAAC,CAACiC,YAAY,CAACT,GAAG,CAAC,CAAC,EAC7BR,GAAG,IAAKD,mBAAmB,CAACC,GAAG,EAAEmB,KAAK,CAAC,CACzC;AACH,CAAC,CACF;AAED;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAME,IAAI,GAAOF,KAAe,IAAK,CAAC,GAAGQ,QAAkB,KAChEV,YAAY,CAACE,KAAK,EAAEQ,QAAQ,CAAC;AAE/B;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMC,IAAI,GAAO1B,IAAwB,IAA4BjB,MAAM,CAACmC,GAAG,CAAC5B,KAAK,CAACqC,GAAG,CAAC3B,IAAI,CAACF,GAAG,CAAC,EAAEhB,CAAC,CAAC4C,IAAI,CAAC;AAEnH;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAME,OAAO,GAAO5B,IAAwB,IAA6BjB,MAAM,CAACmC,GAAG,CAACQ,IAAI,CAAC1B,IAAI,CAAC,EAAG6B,CAAC,IAAKA,CAAC,KAAK,CAAC,CAAC;AAEtH;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMC,UAAU,GAAO9B,IAAwB,IAA6BjB,MAAM,CAACmC,GAAG,CAACQ,IAAI,CAAC1B,IAAI,CAAC,EAAG6B,CAAC,IAAKA,CAAC,GAAG,CAAC,CAAC;AAEvH;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAME,IAAI,GAAO/B,IAAwB,IAC9CjB,MAAM,CAACiD,GAAG,CAAC,aAAS;EAClB,MAAM5B,KAAK,GAAG,OAAOd,KAAK,CAACqC,GAAG,CAAC3B,IAAI,CAACF,GAAG,CAAC;EACxC,MAAMmC,IAAI,GAAGnD,CAAC,CAACmD,IAAI,CAAC7B,KAAK,CAAC;EAC1B,IAAIjB,CAAC,CAAC+C,MAAM,CAACD,IAAI,CAAC,EAAE;IAClB,OAAO,OAAOlD,MAAM,CAACoD,OAAO;EAC9B;EACA,OAAOF,IAAI,CAAC5B,KAAK;AACnB,CAAC,CAAC,CAACV,IAAI,CAACZ,MAAM,CAACqD,EAAE,CAAC;AAEpB;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAMC,UAAU,GAAOrC,IAAwB,IACpDjB,MAAM,CAACmC,GAAG,CAAC5B,KAAK,CAACqC,GAAG,CAAC3B,IAAI,CAACF,GAAG,CAAC,EAAEhB,CAAC,CAACmD,IAAI,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,MAAMK,KAAK,gBA2CdtD,IAAI,CACN,CAAC,EACD,CAAIgB,IAAwB,EAAEK,KAAQ,KACpCf,KAAK,CAACiD,MAAM,CAACvC,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAKD,YAAY,CAACC,KAAK,EAAEC,KAAK,EAAEL,IAAI,CAACD,GAAG,CAAC,CAAC,CAC1E;AAED;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAMyC,QAAQ,gBAyCjBxD,IAAI,CACN,CAAC,EACD,CAAIgB,IAAwB,EAAEyC,MAAmB,KAC/CnD,KAAK,CAACiD,MAAM,CAACvC,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAI;EAC/B,MAAME,GAAG,GAAG,CAAC,GAAGxB,CAAC,CAACyB,OAAO,CAACH,KAAK,CAAC,EAAE,GAAGqC,MAAM,CAAC,CAACnB,IAAI,CAAC,CAACC,CAAC,EAAEC,CAAC,KAAKxB,IAAI,CAACD,GAAG,CAACwB,CAAC,EAAEC,CAAC,CAAC,CAAC;EAC3E,OAAO1C,CAAC,CAACiC,YAAY,CAACT,GAAG,CAAC;AAC5B,CAAC,CAAC,CACL;AAED;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMoC,IAAI,GAAO1C,IAAwB,IAC9CjB,MAAM,CAACiD,GAAG,CAAC,aAAS;EAClB,MAAM5B,KAAK,GAAG,OAAOd,KAAK,CAACqC,GAAG,CAAC3B,IAAI,CAACF,GAAG,CAAC;EACxC,MAAMmC,IAAI,GAAGnD,CAAC,CAACmD,IAAI,CAAC7B,KAAK,CAAC;EAC1B,IAAIjB,CAAC,CAAC+C,MAAM,CAACD,IAAI,CAAC,EAAE;IAClB,OAAO,OAAOlD,MAAM,CAACoD,OAAO;EAC9B;EACA,OAAO7C,KAAK,CAACqD,GAAG,CAAC3C,IAAI,CAACF,GAAG,EAAEhB,CAAC,CAAC8D,IAAI,CAACxC,KAAK,EAAE,CAAC,CAAC,CAAC;EAC5C,OAAO6B,IAAI,CAAC5B,KAAK;AACnB,CAAC,CAAC,CAACV,IAAI,CAACZ,MAAM,CAACqD,EAAE,CAAC;AAEpB;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMS,OAAO,GAAO7C,IAAwB,IACjDjB,MAAM,CAACmC,GAAG,CACR5B,KAAK,CAACwD,MAAM,CAAC9C,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAK,CAACA,KAAK,EAAEtB,CAAC,CAACkC,KAAK,EAAE,CAAC,CAAC,EACrDlC,CAAC,CAACyB,OAAO,CACV;AAEH;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMwC,UAAU,GAAO/C,IAAwB,IACpDV,KAAK,CAACwD,MAAM,CAAC9C,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAI;EAC/B,MAAM6B,IAAI,GAAGnD,CAAC,CAACmD,IAAI,CAAC7B,KAAK,CAAC;EAC1B,IAAIjB,CAAC,CAAC+C,MAAM,CAACD,IAAI,CAAC,EAAE;IAClB,OAAO,CAAC9C,CAAC,CAAC6D,IAAI,EAAK,EAAE5C,KAAK,CAAC;EAC7B;EACA,OAAO,CAACjB,CAAC,CAAC8D,IAAI,CAAChB,IAAI,CAAC5B,KAAK,CAAC,EAAEvB,CAAC,CAAC8D,IAAI,CAACxC,KAAK,EAAE,CAAC,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAM8C,QAAQ,gBAuCjBlE,IAAI,CACN,CAAC,EACD,CAAIgB,IAAwB,EAAE6B,CAAS,KACrC9C,MAAM,CAACmC,GAAG,CACR5B,KAAK,CAACwD,MAAM,CAAC9C,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAI;EAC/B,MAAM+C,KAAK,GAAGrE,CAAC,CAAC4D,IAAI,CAACtC,KAAK,EAAEyB,CAAC,CAAC;EAC9B,MAAMuB,IAAI,GAAGtE,CAAC,CAAC8D,IAAI,CAACxC,KAAK,EAAEyB,CAAC,CAAC;EAC7B,OAAO,CAACsB,KAAK,EAAEC,IAAI,CAAC;AACtB,CAAC,CAAC,EACFtE,CAAC,CAACyB,OAAO,CACV,CACJ;AAED;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAM8C,QAAQ,gBAyCjBrE,IAAI,CACN,CAAC,EACD,CAAIgB,IAAwB,EAAEsD,SAAuB,KACnDhE,KAAK,CAACiD,MAAM,CAACvC,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAKtB,CAAC,CAACyE,MAAM,CAACnD,KAAK,EAAGmB,CAAC,IAAK,CAAC+B,SAAS,CAAC/B,CAAC,CAAC,CAAC,CAAC,CAC3E;AAED;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAMiC,QAAQ,gBAyCjBxE,IAAI,CACN,CAAC,EACD,CAAIgB,IAAwB,EAAEsD,SAAuB,KACnDhE,KAAK,CAACiD,MAAM,CAACvC,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAKtB,CAAC,CAACyE,MAAM,CAACnD,KAAK,EAAEkD,SAAS,CAAC,CAAC,CAChE;AAED;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAM/C,OAAO,GAAOP,IAAwB,IACjDjB,MAAM,CAACmC,GAAG,CAAC5B,KAAK,CAACqC,GAAG,CAAC3B,IAAI,CAACF,GAAG,CAAC,EAAEhB,CAAC,CAACyB,OAAO,CAAC;AAE5C;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMkD,iBAAiB,GAAIC,CAAU,IAAoCrE,WAAW,CAACqE,CAAC,EAAEnE,MAAM,CAAC","ignoreList":[]}
+{"version":3,"file":"TxPriorityQueue.js","names":["C","Effect","dual","NodeInspectSymbol","toJson","O","pipeArguments","hasProperty","TxRef","TypeId","TxPriorityQueueProto","toJSON","_id","pipe","arguments","makeTxPriorityQueue","ref","ord","self","Object","create","insertSorted","chunk","value","arr","toArray","lo","hi","length","mid","out","Array","i","fromIterable","empty","order","map","make","iterable","from","sort","a","b","elements","size","get","isEmpty","n","isNonEmpty","peek","gen","head","isNone","txRetry","tx","peekOption","offer","update","offerAll","values","take","set","drop","takeAll","modify","takeOption","none","some","takeUpTo","taken","rest","removeIf","predicate","filter","retainIf","isTxPriorityQueue","u"],"sources":["../src/TxPriorityQueue.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCA,OAAO,KAAKA,CAAC,MAAM,YAAY;AAC/B,OAAO,KAAKC,MAAM,MAAM,aAAa;AACrC,SAASC,IAAI,QAAQ,eAAe;AAEpC,SAASC,iBAAiB,EAAEC,MAAM,QAAQ,kBAAkB;AAE5D,OAAO,KAAKC,CAAC,MAAM,aAAa;AAGhC,SAASC,aAAa,QAAQ,eAAe;AAC7C,SAASC,WAAW,QAAwB,gBAAgB;AAC5D,OAAO,KAAKC,KAAK,MAAM,YAAY;AAEnC,MAAMC,MAAM,GAAG,sCAAsC;AAmCrD,MAAMC,oBAAoB,GAAkE;EAC1F,CAACP,iBAAiB,IAAC;IACjB,OAAOC,MAAM,CAAC,IAAI,CAAC;EACrB,CAAC;EACDO,MAAMA,CAAA;IACJ,OAAO;MACLC,GAAG,EAAE;KACN;EACH,CAAC;EACDC,IAAIA,CAAA;IACF,OAAOP,aAAa,CAAC,IAAI,EAAEQ,SAAS,CAAC;EACvC;CACD;AAED,MAAMC,mBAAmB,GAAGA,CAAIC,GAA0B,EAAEC,GAAa,KAAwB;EAC/F,MAAMC,IAAI,GAAGC,MAAM,CAACC,MAAM,CAACV,oBAAoB,CAAC;EAChDQ,IAAI,CAACT,MAAM,CAAC,GAAGA,MAAM;EACrBS,IAAI,CAACF,GAAG,GAAGA,GAAG;EACdE,IAAI,CAACD,GAAG,GAAGA,GAAG;EACd,OAAOC,IAAI;AACb,CAAC;AAED,MAAMG,YAAY,GAAGA,CAAIC,KAAe,EAAEC,KAAQ,EAAEN,GAAa,KAAc;EAC7E,MAAMO,GAAG,GAAGxB,CAAC,CAACyB,OAAO,CAACH,KAAK,CAAa;EACxC,IAAII,EAAE,GAAG,CAAC;EACV,IAAIC,EAAE,GAAGH,GAAG,CAACI,MAAM;EACnB,OAAOF,EAAE,GAAGC,EAAE,EAAE;IACd,MAAME,GAAG,GAAIH,EAAE,GAAGC,EAAE,KAAM,CAAC;IAC3B,IAAIV,GAAG,CAACO,GAAG,CAACK,GAAG,CAAC,EAAEN,KAAK,CAAC,IAAI,CAAC,EAAE;MAC7BG,EAAE,GAAGG,GAAG,GAAG,CAAC;IACd,CAAC,MAAM;MACLF,EAAE,GAAGE,GAAG;IACV;EACF;EACA,MAAMC,GAAG,GAAGC,KAAK,CAACP,GAAG,CAACI,MAAM,GAAG,CAAC,CAAa;EAC7C,KAAK,IAAII,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGN,EAAE,EAAEM,CAAC,EAAE,EAAEF,GAAG,CAACE,CAAC,CAAC,GAAGR,GAAG,CAACQ,CAAC,CAAC;EAC5CF,GAAG,CAACJ,EAAE,CAAC,GAAGH,KAAK;EACf,KAAK,IAAIS,CAAC,GAAGN,EAAE,EAAEM,CAAC,GAAGR,GAAG,CAACI,MAAM,EAAEI,CAAC,EAAE,EAAEF,GAAG,CAACE,CAAC,GAAG,CAAC,CAAC,GAAGR,GAAG,CAACQ,CAAC,CAAC;EACzD,OAAOhC,CAAC,CAACiC,YAAY,CAACH,GAAG,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMI,KAAK,GAAOC,KAAe,IACtClC,MAAM,CAACmC,GAAG,CAAC5B,KAAK,CAAC6B,IAAI,CAAWrC,CAAC,CAACkC,KAAK,EAAE,CAAC,EAAGlB,GAAG,IAAKD,mBAAmB,CAACC,GAAG,EAAEmB,KAAK,CAAC,CAAC;AAEvF;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMF,YAAY,gBAuCrB/B,IAAI,CACN,CAAC,EACD,CAAIiC,KAAe,EAAEG,QAAqB,KAAuC;EAC/E,MAAMd,GAAG,GAAGO,KAAK,CAACQ,IAAI,CAACD,QAAQ,CAAC,CAACE,IAAI,CAAC,CAACC,CAAC,EAAEC,CAAC,KAAKP,KAAK,CAACM,CAAC,EAAEC,CAAC,CAAC,CAAC;EAC5D,OAAOzC,MAAM,CAACmC,GAAG,CACf5B,KAAK,CAAC6B,IAAI,CAkBArC,CAAC,CAACiC,YAAY,CAACT,GAAG,CAAC,CAAC,EAC7BR,GAAG,IAAKD,mBAAmB,CAACC,GAAG,EAAEmB,KAAK,CAAC,CACzC;AACH,CAAC,CACF;AAED;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAME,IAAI,GAAOF,KAAe,IAAK,CAAC,GAAGQ,QAAkB,KAChEV,YAAY,CAACE,KAAK,EAAEQ,QAAQ,CAAC;AAE/B;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMC,IAAI,GAAO1B,IAAwB,IAA4BjB,MAAM,CAACmC,GAAG,CAAC5B,KAAK,CAACqC,GAAG,CAAC3B,IAAI,CAACF,GAAG,CAAC,EAAEhB,CAAC,CAAC4C,IAAI,CAAC;AAEnH;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAME,OAAO,GAAO5B,IAAwB,IAA6BjB,MAAM,CAACmC,GAAG,CAACQ,IAAI,CAAC1B,IAAI,CAAC,EAAG6B,CAAC,IAAKA,CAAC,KAAK,CAAC,CAAC;AAEtH;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMC,UAAU,GAAO9B,IAAwB,IAA6BjB,MAAM,CAACmC,GAAG,CAACQ,IAAI,CAAC1B,IAAI,CAAC,EAAG6B,CAAC,IAAKA,CAAC,GAAG,CAAC,CAAC;AAEvH;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAME,IAAI,GAAO/B,IAAwB,IAC9CjB,MAAM,CAACiD,GAAG,CAAC,aAAS;EAClB,MAAM5B,KAAK,GAAG,OAAOd,KAAK,CAACqC,GAAG,CAAC3B,IAAI,CAACF,GAAG,CAAC;EACxC,MAAMmC,IAAI,GAAGnD,CAAC,CAACmD,IAAI,CAAC7B,KAAK,CAAC;EAC1B,IAAIjB,CAAC,CAAC+C,MAAM,CAACD,IAAI,CAAC,EAAE;IAClB,OAAO,OAAOlD,MAAM,CAACoD,OAAO;EAC9B;EACA,OAAOF,IAAI,CAAC5B,KAAK;AACnB,CAAC,CAAC,CAACV,IAAI,CAACZ,MAAM,CAACqD,EAAE,CAAC;AAEpB;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAMC,UAAU,GAAOrC,IAAwB,IACpDjB,MAAM,CAACmC,GAAG,CAAC5B,KAAK,CAACqC,GAAG,CAAC3B,IAAI,CAACF,GAAG,CAAC,EAAEhB,CAAC,CAACmD,IAAI,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,MAAMK,KAAK,gBA2CdtD,IAAI,CACN,CAAC,EACD,CAAIgB,IAAwB,EAAEK,KAAQ,KACpCf,KAAK,CAACiD,MAAM,CAACvC,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAKD,YAAY,CAACC,KAAK,EAAEC,KAAK,EAAEL,IAAI,CAACD,GAAG,CAAC,CAAC,CAC1E;AAED;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAMyC,QAAQ,gBAyCjBxD,IAAI,CACN,CAAC,EACD,CAAIgB,IAAwB,EAAEyC,MAAmB,KAC/CnD,KAAK,CAACiD,MAAM,CAACvC,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAI;EAC/B,MAAME,GAAG,GAAG,CAAC,GAAGxB,CAAC,CAACyB,OAAO,CAACH,KAAK,CAAC,EAAE,GAAGqC,MAAM,CAAC,CAACnB,IAAI,CAAC,CAACC,CAAC,EAAEC,CAAC,KAAKxB,IAAI,CAACD,GAAG,CAACwB,CAAC,EAAEC,CAAC,CAAC,CAAC;EAC3E,OAAO1C,CAAC,CAACiC,YAAY,CAACT,GAAG,CAAC;AAC5B,CAAC,CAAC,CACL;AAED;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMoC,IAAI,GAAO1C,IAAwB,IAC9CjB,MAAM,CAACiD,GAAG,CAAC,aAAS;EAClB,MAAM5B,KAAK,GAAG,OAAOd,KAAK,CAACqC,GAAG,CAAC3B,IAAI,CAACF,GAAG,CAAC;EACxC,MAAMmC,IAAI,GAAGnD,CAAC,CAACmD,IAAI,CAAC7B,KAAK,CAAC;EAC1B,IAAIjB,CAAC,CAAC+C,MAAM,CAACD,IAAI,CAAC,EAAE;IAClB,OAAO,OAAOlD,MAAM,CAACoD,OAAO;EAC9B;EACA,OAAO7C,KAAK,CAACqD,GAAG,CAAC3C,IAAI,CAACF,GAAG,EAAEhB,CAAC,CAAC8D,IAAI,CAACxC,KAAK,EAAE,CAAC,CAAC,CAAC;EAC5C,OAAO6B,IAAI,CAAC5B,KAAK;AACnB,CAAC,CAAC,CAACV,IAAI,CAACZ,MAAM,CAACqD,EAAE,CAAC;AAEpB;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMS,OAAO,GAAO7C,IAAwB,IACjDjB,MAAM,CAACmC,GAAG,CACR5B,KAAK,CAACwD,MAAM,CAAC9C,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAK,CAACA,KAAK,EAAEtB,CAAC,CAACkC,KAAK,EAAE,CAAC,CAAC,EACrDlC,CAAC,CAACyB,OAAO,CACV;AAEH;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMwC,UAAU,GAAO/C,IAAwB,IACpDV,KAAK,CAACwD,MAAM,CAAC9C,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAI;EAC/B,MAAM6B,IAAI,GAAGnD,CAAC,CAACmD,IAAI,CAAC7B,KAAK,CAAC;EAC1B,IAAIjB,CAAC,CAAC+C,MAAM,CAACD,IAAI,CAAC,EAAE;IAClB,OAAO,CAAC9C,CAAC,CAAC6D,IAAI,EAAK,EAAE5C,KAAK,CAAC;EAC7B;EACA,OAAO,CAACjB,CAAC,CAAC8D,IAAI,CAAChB,IAAI,CAAC5B,KAAK,CAAC,EAAEvB,CAAC,CAAC8D,IAAI,CAACxC,KAAK,EAAE,CAAC,CAAC,CAAC;AAC/C,CAAC,CAAC;AAEJ;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAM8C,QAAQ,gBAuCjBlE,IAAI,CACN,CAAC,EACD,CAAIgB,IAAwB,EAAE6B,CAAS,KACrC9C,MAAM,CAACmC,GAAG,CACR5B,KAAK,CAACwD,MAAM,CAAC9C,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAI;EAC/B,MAAM+C,KAAK,GAAGrE,CAAC,CAAC4D,IAAI,CAACtC,KAAK,EAAEyB,CAAC,CAAC;EAC9B,MAAMuB,IAAI,GAAGtE,CAAC,CAAC8D,IAAI,CAACxC,KAAK,EAAEyB,CAAC,CAAC;EAC7B,OAAO,CAACsB,KAAK,EAAEC,IAAI,CAAC;AACtB,CAAC,CAAC,EACFtE,CAAC,CAACyB,OAAO,CACV,CACJ;AAED;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAM8C,QAAQ,gBAyCjBrE,IAAI,CACN,CAAC,EACD,CAAIgB,IAAwB,EAAEsD,SAAuB,KACnDhE,KAAK,CAACiD,MAAM,CAACvC,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAKtB,CAAC,CAACyE,MAAM,CAACnD,KAAK,EAAGmB,CAAC,IAAK,CAAC+B,SAAS,CAAC/B,CAAC,CAAC,CAAC,CAAC,CAC3E;AAED;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAMiC,QAAQ,gBAyCjBxE,IAAI,CACN,CAAC,EACD,CAAIgB,IAAwB,EAAEsD,SAAuB,KACnDhE,KAAK,CAACiD,MAAM,CAACvC,IAAI,CAACF,GAAG,EAAGM,KAAK,IAAKtB,CAAC,CAACyE,MAAM,CAACnD,KAAK,EAAEkD,SAAS,CAAC,CAAC,CAChE;AAED;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAM/C,OAAO,GAAOP,IAAwB,IACjDjB,MAAM,CAACmC,GAAG,CAAC5B,KAAK,CAACqC,GAAG,CAAC3B,IAAI,CAACF,GAAG,CAAC,EAAEhB,CAAC,CAACyB,OAAO,CAAC;AAE5C;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMkD,iBAAiB,GAAIC,CAAU,IAAoCrE,WAAW,CAACqE,CAAC,EAAEnE,MAAM,CAAC","ignoreList":[]}

package/dist/TxPubSub.d.ts

@@ -1,9 +1,49 @@
 /**
- * TxPubSub is a transactional publish/subscribe hub that provides Software Transactional Memory
- * (STM) semantics for message broadcasting. Publishers broadcast messages to all current
- * subscribers, with each subscriber receiving its own copy of every published message.
+ * The `TxPubSub` module provides a transactional publish/subscribe hub for
+ * broadcasting values to scoped subscribers. Each subscriber owns a `TxQueue`,
+ * so every value is offered independently to the queues registered at the time
+ * of publication.
  *
- * Supports multiple queue strategies: bounded, unbounded, dropping, and sliding.
+ * **Mental model**
+ *
+ * A `TxPubSub` is a registry of subscriber queues plus a shutdown flag.
+ * Publishing reads the current subscribers and offers the value to each queue
+ * in one transactional operation. Subscribers only receive values published
+ * after they subscribe, and `subscribe` removes the queue when its scope
+ * closes.
+ *
+ * **Common tasks**
+ *
+ * - Use `bounded` when slow subscribers should apply backpressure to
+ *   publishers.
+ * - Use `dropping` when new messages may be skipped for full subscribers.
+ * - Use `sliding` when full subscribers should keep the newest messages.
+ * - Use `unbounded` when subscriber queues should grow without backpressure.
+ *
+ * **Example** (Broadcasting to a subscriber)
+ *
+ * ```ts
+ * import { Effect, TxPubSub, TxQueue } from "effect"
+ *
+ * const program = Effect.gen(function*() {
+ *   const hub = yield* TxPubSub.unbounded<string>()
+ *
+ *   return yield* Effect.scoped(
+ *     Effect.gen(function*() {
+ *       const subscriber = yield* TxPubSub.subscribe(hub)
+ *       yield* TxPubSub.publish(hub, "updated")
+ *       return yield* TxQueue.take(subscriber)
+ *     })
+ *   )
+ * })
+ * ```
+ *
+ * **Gotchas**
+ *
+ * - `size` reports the maximum pending messages in any subscriber queue, not
+ *   the total number of queued copies.
+ * - `shutdown` stops future publishes and shuts down subscriber queues that are
+ *   registered at shutdown time.
  *
  * @since 4.0.0
  */
@@ -202,7 +242,7 @@ export declare const capacity: <A>(self: TxPubSub<A>) => number;
  */
 export declare const size: <A>(self: TxPubSub<A>) => Effect.Effect<number>;
 /**
- * Checks if the TxPubSub has no pending messages (all subscriber queues are empty).
+ * Checks whether the TxPubSub has no pending messages (all subscriber queues are empty).
  *
  * **Example** (Checking whether a pub/sub is empty)
  *
@@ -221,7 +261,7 @@ export declare const size: <A>(self: TxPubSub<A>) => Effect.Effect<number>;
  */
 export declare const isEmpty: <A>(self: TxPubSub<A>) => Effect.Effect<boolean>;
 /**
- * Checks if any subscriber queue is at capacity.
+ * Checks whether any subscriber queue is at capacity.
  *
  * **Example** (Checking whether a pub/sub is full)
  *
@@ -240,7 +280,7 @@ export declare const isEmpty: <A>(self: TxPubSub<A>) => Effect.Effect<boolean>;
  */
 export declare const isFull: <A>(self: TxPubSub<A>) => Effect.Effect<boolean>;
 /**
- * Checks if the TxPubSub has been shut down.
+ * Checks whether the TxPubSub has been shut down.
  *
  * **Example** (Checking whether a pub/sub is shut down)
  *
@@ -496,10 +536,18 @@ export declare const subscribe: <A>(self: TxPubSub<A>) => Effect.Effect<TxQueue.
 /**
  * Creates a subscriber queue and registers it with the pub/sub.
  *
+ * **When to use**
+ *
+ * Use to create and register a subscriber queue inside a larger transaction
+ * when registration must be atomic with other Tx operations.
+ *
  * **Details**
  *
  * This is the transactional acquire step of `subscribe`, exposed so that callers can compose it with other Tx operations in a single transaction, such as `TxSubscriptionRef.changes`.
  *
+ * @see {@link subscribe} for the scoped acquire and release wrapper when no custom transaction composition is needed
+ * @see {@link releaseSubscriber} to remove and shut down a queue returned by `acquireSubscriber`
+ *
  * @category mutations
  * @since 4.0.0
  */
@@ -507,10 +555,24 @@ export declare const acquireSubscriber: <A>(self: TxPubSub<A>) => Effect.Effect<
 /**
  * Removes a subscriber queue from the pub/sub and shuts it down.
  *
+ * **When to use**
+ *
+ * Use to release a manually acquired subscriber queue inside a larger
+ * transaction, removing it from the pub/sub and shutting it down together with
+ * related transactional cleanup.
+ *
  * **Details**
  *
  * This is the transactional release step of `subscribe`, exposed so that callers can compose it with other Tx operations in a single transaction.
  *
+ * **Gotchas**
+ *
+ * The supplied queue is shut down after being removed, so callers should pass a
+ * queue acquired for this pub/sub.
+ *
+ * @see {@link acquireSubscriber} for the matching transactional acquire step
+ * @see {@link subscribe} for the scoped acquire and release wrapper
+ *
  * @category mutations
  * @since 4.0.0
  */
@@ -518,10 +580,24 @@ export declare const releaseSubscriber: {
     /**
      * Removes a subscriber queue from the pub/sub and shuts it down.
      *
+     * **When to use**
+     *
+     * Use to release a manually acquired subscriber queue inside a larger
+     * transaction, removing it from the pub/sub and shutting it down together with
+     * related transactional cleanup.
+     *
      * **Details**
      *
      * This is the transactional release step of `subscribe`, exposed so that callers can compose it with other Tx operations in a single transaction.
      *
+     * **Gotchas**
+     *
+     * The supplied queue is shut down after being removed, so callers should pass a
+     * queue acquired for this pub/sub.
+     *
+     * @see {@link acquireSubscriber} for the matching transactional acquire step
+     * @see {@link subscribe} for the scoped acquire and release wrapper
+     *
      * @category mutations
      * @since 4.0.0
      */
@@ -529,10 +605,24 @@ export declare const releaseSubscriber: {
     /**
      * Removes a subscriber queue from the pub/sub and shuts it down.
      *
+     * **When to use**
+     *
+     * Use to release a manually acquired subscriber queue inside a larger
+     * transaction, removing it from the pub/sub and shutting it down together with
+     * related transactional cleanup.
+     *
      * **Details**
      *
      * This is the transactional release step of `subscribe`, exposed so that callers can compose it with other Tx operations in a single transaction.
      *
+     * **Gotchas**
+     *
+     * The supplied queue is shut down after being removed, so callers should pass a
+     * queue acquired for this pub/sub.
+     *
+     * @see {@link acquireSubscriber} for the matching transactional acquire step
+     * @see {@link subscribe} for the scoped acquire and release wrapper
+     *
      * @category mutations
      * @since 4.0.0
      */
@@ -592,7 +682,7 @@ export declare const shutdown: <A>(self: TxPubSub<A>) => Effect.Effect<void>;
  */
 export declare const awaitShutdown: <A>(self: TxPubSub<A>) => Effect.Effect<void>;
 /**
- * Checks if the given value is a TxPubSub.
+ * Checks whether the given value is a TxPubSub.
  *
  * **Example** (Checking for a TxPubSub)
  *

package/dist/TxPubSub.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TxPubSub.d.ts","sourceRoot":"","sources":["../src/TxPubSub.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAG7C,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAGvC,QAAA,MAAM,MAAM,kCAAkC,CAAA;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,WAAW,EAAE,QAAQ;IAC/D,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAKhC,QAAQ,CAAC,QAAQ,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,CAAA;IACnE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AAwCD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,GAAG,KAAK,EAAE,UAAU,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAK3D,CAAA;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,GAAG,KAAK,EAAE,UAAU,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAK5D,CAAA;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,GAAG,KAAK,EAAE,UAAU,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAK3D,CAAA;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,GAAG,KAAK,OAAK,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAK7C,CAAA;AAMpB;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAuB,CAAA;AAEvE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAS5C,CAAA;AAEpB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAA2C,CAAA;AAE/G;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAQ/C,CAAA;AAEpB;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAgC,CAAA;AAMvG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,OAAO,EAAE;IAKpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAK5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;CAiBzD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;CAcpE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAIlG,CAAA;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,EACjC,MAAM,QAAQ,CAAC,CAAC,CAAC,KAChB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,WAAW,CAK1D,CAAA;AAEJ;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,EAAE;IAC9B;;;;;;;;;OASG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,CAAA;IACrG;;;;;;;;;OASG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,CAAA;CAWlG,CAAA;AAkBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAU9C,CAAA;AAEpB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAKnD,CAAA;AAMpB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,QAAQ,CAAC,OAAO,CAA2B,CAAA"}
+{"version":3,"file":"TxPubSub.d.ts","sourceRoot":"","sources":["../src/TxPubSub.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAG7C,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAGvC,QAAA,MAAM,MAAM,kCAAkC,CAAA;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,WAAW,EAAE,QAAQ;IAC/D,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAKhC,QAAQ,CAAC,QAAQ,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,CAAA;IACnE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AAwCD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,GAAG,KAAK,EAAE,UAAU,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAK3D,CAAA;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,GAAG,KAAK,EAAE,UAAU,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAK5D,CAAA;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,GAAG,KAAK,EAAE,UAAU,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAK3D,CAAA;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,GAAG,KAAK,OAAK,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAK7C,CAAA;AAMpB;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAuB,CAAA;AAEvE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAS5C,CAAA;AAEpB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAA2C,CAAA;AAE/G;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAQ/C,CAAA;AAEpB;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAgC,CAAA;AAMvG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,OAAO,EAAE;IAKpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAK5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;CAiBzD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;CAcpE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAIlG,CAAA;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,EACjC,MAAM,QAAQ,CAAC,CAAC,CAAC,KAChB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,WAAW,CAK1D,CAAA;AAEJ;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,iBAAiB,EAAE;IAC9B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,CAAA;IACrG;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,CAAA;CAWlG,CAAA;AAkBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAU9C,CAAA;AAEpB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAKnD,CAAA;AAMpB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,QAAQ,CAAC,OAAO,CAA2B,CAAA"}