effect 4.0.0-beta.69 → 4.0.0-beta.70

package/src/TxChunk.ts

@@ -26,6 +26,8 @@ const TypeId = "~effect/transactions/TxChunk"
  * TxChunk is a transactional chunk data structure that provides Software Transactional Memory (STM)
  * semantics for chunk operations.
  *
+ * **Details**
+ *
  * Accessed values are tracked by the transaction in order to detect conflicts and to track changes.
  * A transaction will retry whenever a conflict is detected or whenever the transaction explicitly
  * calls `Effect.txRetry` and any of the accessed TxChunk values change.
@@ -90,8 +92,10 @@ const TxChunkProto = {
 /**
  * Creates a new `TxChunk` with the specified initial chunk.
  *
- * **Return behavior**: This function returns a new TxChunk reference containing
- * the provided initial chunk. No existing TxChunk instances are modified.
+ * **Details**
+ *
+ * This function returns a new TxChunk reference containing the provided initial chunk. No existing
+ * TxChunk instances are modified.
  *
  * **Example** (Creating a TxChunk from a chunk)
  *
@@ -118,8 +122,10 @@ export const make = <A>(initial: Chunk.Chunk<A>): Effect.Effect<TxChunk<A>> =>
 /**
  * Creates a new empty `TxChunk`.
  *
- * **Return behavior**: This function returns a new TxChunk reference that is
- * initially empty. No existing TxChunk instances are modified.
+ * **Details**
+ *
+ * This function returns a new TxChunk reference that is initially empty. No existing TxChunk
+ * instances are modified.
  *
  * **Example** (Creating an empty TxChunk)
  *
@@ -151,8 +157,10 @@ export const empty = <A = never>(): Effect.Effect<TxChunk<A>> =>
 /**
  * Creates a new `TxChunk` from an iterable.
  *
- * **Return behavior**: This function returns a new TxChunk reference containing
- * elements from the provided iterable. No existing TxChunk instances are modified.
+ * **Details**
+ *
+ * This function returns a new TxChunk reference containing elements from the provided iterable. No
+ * existing TxChunk instances are modified.
  *
  * **Example** (Creating from an iterable)
  *
@@ -189,8 +197,10 @@ export const fromIterable = <A>(iterable: Iterable<A>): Effect.Effect<TxChunk<A>
 /**
  * Creates a new `TxChunk` with the specified TxRef.
  *
- * **Return behavior**: This function returns a new TxChunk reference wrapping
- * the provided TxRef. No existing TxChunk instances are modified.
+ * **Details**
+ *
+ * This function returns a new TxChunk reference wrapping the provided TxRef. No existing TxChunk
+ * instances are modified.
  *
  * **Example** (Wrapping an existing TxRef)
  *
@@ -215,8 +225,10 @@ export const makeUnsafe = <A>(ref: TxRef.TxRef<Chunk.Chunk<A>>): TxChunk<A> => {
 /**
  * Modifies the value of the `TxChunk` using the provided function.
  *
- * **Mutation behavior**: This function mutates the original TxChunk by updating
- * its internal state. It does not return a new TxChunk reference.
+ * **Details**
+ *
+ * This function mutates the original TxChunk by updating its internal state. It does not return a
+ * new TxChunk reference.
  *
  * **Example** (Modifying while returning a value)
  *
@@ -246,8 +258,10 @@ export const modify: {
   /**
    * Modifies the value of the `TxChunk` using the provided function.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by updating
-   * its internal state. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by updating its internal state. It does not return a
+   * new TxChunk reference.
    *
    * **Example** (Modifying while returning a value)
    *
@@ -279,8 +293,10 @@ export const modify: {
   /**
    * Modifies the value of the `TxChunk` using the provided function.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by updating
-   * its internal state. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by updating its internal state. It does not return a
+   * new TxChunk reference.
    *
    * **Example** (Modifying while returning a value)
    *
@@ -321,8 +337,10 @@ export const modify: {
 /**
  * Updates the value of the `TxChunk` using the provided function.
  *
- * **Mutation behavior**: This function mutates the original TxChunk by updating
- * its internal state. It does not return a new TxChunk reference.
+ * **Details**
+ *
+ * This function mutates the original TxChunk by updating its internal state. It does not return a
+ * new TxChunk reference.
  *
  * **Example** (Updating the stored chunk)
  *
@@ -347,8 +365,10 @@ export const update: {
   /**
    * Updates the value of the `TxChunk` using the provided function.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by updating
-   * its internal state. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by updating its internal state. It does not return a
+   * new TxChunk reference.
    *
    * **Example** (Updating the stored chunk)
    *
@@ -373,8 +393,10 @@ export const update: {
   /**
    * Updates the value of the `TxChunk` using the provided function.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by updating
-   * its internal state. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by updating its internal state. It does not return a
+   * new TxChunk reference.
    *
    * **Example** (Updating the stored chunk)
    *
@@ -433,8 +455,10 @@ export const get = <A>(self: TxChunk<A>): Effect.Effect<Chunk.Chunk<A>> => TxRef
 /**
  * Sets the value of the `TxChunk`.
  *
- * **Mutation behavior**: This function mutates the original TxChunk by replacing
- * its internal state with the provided chunk. It does not return a new TxChunk reference.
+ * **Details**
+ *
+ * This function mutates the original TxChunk by replacing its internal state with the provided
+ * chunk. It does not return a new TxChunk reference.
  *
  * **Example** (Replacing the stored chunk)
  *
@@ -460,8 +484,10 @@ export const set: {
   /**
    * Sets the value of the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by replacing
-   * its internal state with the provided chunk. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by replacing its internal state with the provided
+   * chunk. It does not return a new TxChunk reference.
    *
    * **Example** (Replacing the stored chunk)
    *
@@ -487,8 +513,10 @@ export const set: {
   /**
    * Sets the value of the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by replacing
-   * its internal state with the provided chunk. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by replacing its internal state with the provided
+   * chunk. It does not return a new TxChunk reference.
    *
    * **Example** (Replacing the stored chunk)
    *
@@ -519,8 +547,10 @@ export const set: {
 /**
  * Appends an element to the end of the `TxChunk`.
  *
- * **Mutation behavior**: This function mutates the original TxChunk by adding
- * the element to the end. It does not return a new TxChunk reference.
+ * **Details**
+ *
+ * This function mutates the original TxChunk by adding the element to the end. It does not return a
+ * new TxChunk reference.
  *
  * **Example** (Appending an element)
  *
@@ -545,8 +575,10 @@ export const append: {
   /**
    * Appends an element to the end of the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by adding
-   * the element to the end. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by adding the element to the end. It does not return a
+   * new TxChunk reference.
    *
    * **Example** (Appending an element)
    *
@@ -571,8 +603,10 @@ export const append: {
   /**
    * Appends an element to the end of the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by adding
-   * the element to the end. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by adding the element to the end. It does not return a
+   * new TxChunk reference.
    *
    * **Example** (Appending an element)
    *
@@ -602,8 +636,10 @@ export const append: {
 /**
  * Prepends an element to the beginning of the `TxChunk`.
  *
- * **Mutation behavior**: This function mutates the original TxChunk by adding
- * the element to the beginning. It does not return a new TxChunk reference.
+ * **Details**
+ *
+ * This function mutates the original TxChunk by adding the element to the beginning. It does not
+ * return a new TxChunk reference.
  *
  * **Example** (Prepending an element)
  *
@@ -628,8 +664,10 @@ export const prepend: {
   /**
    * Prepends an element to the beginning of the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by adding
-   * the element to the beginning. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by adding the element to the beginning. It does not
+   * return a new TxChunk reference.
    *
    * **Example** (Prepending an element)
    *
@@ -654,8 +692,10 @@ export const prepend: {
   /**
    * Prepends an element to the beginning of the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by adding
-   * the element to the beginning. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by adding the element to the beginning. It does not
+   * return a new TxChunk reference.
    *
    * **Example** (Prepending an element)
    *
@@ -767,8 +807,10 @@ export const isNonEmpty = <A>(self: TxChunk<A>): Effect.Effect<boolean> =>
 /**
  * Takes the first `n` elements from the `TxChunk`.
  *
- * **Mutation behavior**: This function mutates the original TxChunk by keeping
- * only the first n elements. It does not return a new TxChunk reference.
+ * **Details**
+ *
+ * This function mutates the original TxChunk by keeping only the first n elements. It does not
+ * return a new TxChunk reference.
  *
  * **Example** (Taking leading elements)
  *
@@ -793,8 +835,10 @@ export const take: {
   /**
    * Takes the first `n` elements from the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by keeping
-   * only the first n elements. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by keeping only the first n elements. It does not
+   * return a new TxChunk reference.
    *
    * **Example** (Taking leading elements)
    *
@@ -819,8 +863,10 @@ export const take: {
   /**
    * Takes the first `n` elements from the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by keeping
-   * only the first n elements. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by keeping only the first n elements. It does not
+   * return a new TxChunk reference.
    *
    * **Example** (Taking leading elements)
    *
@@ -850,8 +896,10 @@ export const take: {
 /**
  * Drops the first `n` elements from the `TxChunk`.
  *
- * **Mutation behavior**: This function mutates the original TxChunk by removing
- * the first n elements. It does not return a new TxChunk reference.
+ * **Details**
+ *
+ * This function mutates the original TxChunk by removing the first n elements. It does not return a
+ * new TxChunk reference.
  *
  * **Example** (Dropping leading elements)
  *
@@ -876,8 +924,10 @@ export const drop: {
   /**
    * Drops the first `n` elements from the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by removing
-   * the first n elements. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by removing the first n elements. It does not return a
+   * new TxChunk reference.
    *
    * **Example** (Dropping leading elements)
    *
@@ -902,8 +952,10 @@ export const drop: {
   /**
    * Drops the first `n` elements from the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by removing
-   * the first n elements. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by removing the first n elements. It does not return a
+   * new TxChunk reference.
    *
    * **Example** (Dropping leading elements)
    *
@@ -933,8 +985,10 @@ export const drop: {
 /**
  * Takes a slice of the `TxChunk` from `start` to `end` (exclusive).
  *
- * **Mutation behavior**: This function mutates the original TxChunk by keeping
- * only the elements in the specified range. It does not return a new TxChunk reference.
+ * **Details**
+ *
+ * This function mutates the original TxChunk by keeping only the elements in the specified range. It
+ * does not return a new TxChunk reference.
  *
  * **Example** (Taking a slice)
  *
@@ -959,8 +1013,10 @@ export const slice: {
   /**
    * Takes a slice of the `TxChunk` from `start` to `end` (exclusive).
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by keeping
-   * only the elements in the specified range. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by keeping only the elements in the specified range. It
+   * does not return a new TxChunk reference.
    *
    * **Example** (Taking a slice)
    *
@@ -985,8 +1041,10 @@ export const slice: {
   /**
    * Takes a slice of the `TxChunk` from `start` to `end` (exclusive).
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by keeping
-   * only the elements in the specified range. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by keeping only the elements in the specified range. It
+   * does not return a new TxChunk reference.
    *
    * **Example** (Taking a slice)
    *
@@ -1018,9 +1076,10 @@ export const slice: {
  * Maps each element of the `TxChunk` using a function that returns the same
  * element type.
  *
- * **Mutation behavior**: This function mutates the original `TxChunk` by
- * transforming each element in place. It does not return a new `TxChunk`
- * reference.
+ * **Details**
+ *
+ * This function mutates the original `TxChunk` by transforming each element in place. It does not
+ * return a new `TxChunk` reference.
  *
  * **Example** (Mapping elements)
  *
@@ -1046,9 +1105,10 @@ export const map: {
    * Maps each element of the `TxChunk` using a function that returns the same
    * element type.
    *
-   * **Mutation behavior**: This function mutates the original `TxChunk` by
-   * transforming each element in place. It does not return a new `TxChunk`
-   * reference.
+   * **Details**
+   *
+   * This function mutates the original `TxChunk` by transforming each element in place. It does not
+   * return a new `TxChunk` reference.
    *
    * **Example** (Mapping elements)
    *
@@ -1074,9 +1134,10 @@ export const map: {
    * Maps each element of the `TxChunk` using a function that returns the same
    * element type.
    *
-   * **Mutation behavior**: This function mutates the original `TxChunk` by
-   * transforming each element in place. It does not return a new `TxChunk`
-   * reference.
+   * **Details**
+   *
+   * This function mutates the original `TxChunk` by transforming each element in place. It does not
+   * return a new `TxChunk` reference.
    *
    * **Example** (Mapping elements)
    *
@@ -1106,8 +1167,10 @@ export const map: {
 /**
  * Filters the `TxChunk` keeping only elements that satisfy the predicate.
  *
- * **Mutation behavior**: This function mutates the original TxChunk by removing
- * elements that don't match the predicate. It does not return a new TxChunk reference.
+ * **Details**
+ *
+ * This function mutates the original TxChunk by removing elements that don't match the predicate. It
+ * does not return a new TxChunk reference.
  *
  * **Example** (Filtering elements)
  *
@@ -1132,8 +1195,10 @@ export const filter: {
   /**
    * Filters the `TxChunk` keeping only elements that satisfy the predicate.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by removing
-   * elements that don't match the predicate. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by removing elements that don't match the predicate. It
+   * does not return a new TxChunk reference.
    *
    * **Example** (Filtering elements)
    *
@@ -1158,8 +1223,10 @@ export const filter: {
   /**
    * Filters the `TxChunk` keeping only elements that satisfy the predicate.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by removing
-   * elements that don't match the predicate. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by removing elements that don't match the predicate. It
+   * does not return a new TxChunk reference.
    *
    * **Example** (Filtering elements)
    *
@@ -1184,8 +1251,10 @@ export const filter: {
   /**
    * Filters the `TxChunk` keeping only elements that satisfy the predicate.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by removing
-   * elements that don't match the predicate. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by removing elements that don't match the predicate. It
+   * does not return a new TxChunk reference.
    *
    * **Example** (Filtering elements)
    *
@@ -1210,8 +1279,10 @@ export const filter: {
   /**
    * Filters the `TxChunk` keeping only elements that satisfy the predicate.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by removing
-   * elements that don't match the predicate. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by removing elements that don't match the predicate. It
+   * does not return a new TxChunk reference.
    *
    * **Example** (Filtering elements)
    *
@@ -1242,8 +1313,10 @@ export const filter: {
 /**
  * Concatenates another chunk to the end of the `TxChunk`.
  *
- * **Mutation behavior**: This function mutates the original TxChunk by appending
- * all elements from the other chunk. It does not return a new TxChunk reference.
+ * **Details**
+ *
+ * This function mutates the original TxChunk by appending all elements from the other chunk. It does
+ * not return a new TxChunk reference.
  *
  * **Example** (Appending another chunk)
  *
@@ -1269,8 +1342,10 @@ export const appendAll: {
   /**
    * Concatenates another chunk to the end of the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by appending
-   * all elements from the other chunk. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by appending all elements from the other chunk. It does
+   * not return a new TxChunk reference.
    *
    * **Example** (Appending another chunk)
    *
@@ -1296,8 +1371,10 @@ export const appendAll: {
   /**
    * Concatenates another chunk to the end of the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by appending
-   * all elements from the other chunk. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by appending all elements from the other chunk. It does
+   * not return a new TxChunk reference.
    *
    * **Example** (Appending another chunk)
    *
@@ -1329,8 +1406,10 @@ export const appendAll: {
 /**
  * Concatenates another chunk to the beginning of the `TxChunk`.
  *
- * **Mutation behavior**: This function mutates the original TxChunk by prepending
- * all elements from the other chunk. It does not return a new TxChunk reference.
+ * **Details**
+ *
+ * This function mutates the original TxChunk by prepending all elements from the other chunk. It
+ * does not return a new TxChunk reference.
  *
  * **Example** (Prepending another chunk)
  *
@@ -1356,8 +1435,10 @@ export const prependAll: {
   /**
    * Concatenates another chunk to the beginning of the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by prepending
-   * all elements from the other chunk. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by prepending all elements from the other chunk. It
+   * does not return a new TxChunk reference.
    *
    * **Example** (Prepending another chunk)
    *
@@ -1383,8 +1464,10 @@ export const prependAll: {
   /**
    * Concatenates another chunk to the beginning of the `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by prepending
-   * all elements from the other chunk. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by prepending all elements from the other chunk. It
+   * does not return a new TxChunk reference.
    *
    * **Example** (Prepending another chunk)
    *
@@ -1416,8 +1499,10 @@ export const prependAll: {
 /**
  * Concatenates another `TxChunk` to the end of this `TxChunk`.
  *
- * **Mutation behavior**: This function mutates the original TxChunk by appending
- * all elements from the other TxChunk. It does not return a new TxChunk reference.
+ * **Details**
+ *
+ * This function mutates the original TxChunk by appending all elements from the other TxChunk. It
+ * does not return a new TxChunk reference.
  *
  * **Example** (Concatenating TxChunks)
  *
@@ -1447,8 +1532,10 @@ export const concat: {
   /**
    * Concatenates another `TxChunk` to the end of this `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by appending
-   * all elements from the other TxChunk. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by appending all elements from the other TxChunk. It
+   * does not return a new TxChunk reference.
    *
    * **Example** (Concatenating TxChunks)
    *
@@ -1478,8 +1565,10 @@ export const concat: {
   /**
    * Concatenates another `TxChunk` to the end of this `TxChunk`.
    *
-   * **Mutation behavior**: This function mutates the original TxChunk by appending
-   * all elements from the other TxChunk. It does not return a new TxChunk reference.
+   * **Details**
+   *
+   * This function mutates the original TxChunk by appending all elements from the other TxChunk. It
+   * does not return a new TxChunk reference.
    *
    * **Example** (Concatenating TxChunks)
    *

package/src/TxDeferred.ts

@@ -21,10 +21,9 @@ import * as TxRef from "./TxRef.ts"
 const TypeId = "~effect/transactions/TxDeferred"
 
 /**
- * A transactional deferred — a write-once cell readable within transactions.
- *
- * Readers block (retry the transaction) until a value is committed.
- * Writers succeed only on the first call; subsequent writes return `false`.
+ * A transactional deferred is a write-once cell readable within transactions.
+ * Readers block (retry the transaction) until a value is committed, and writers
+ * succeed only on the first call; subsequent writes return `false`.
  *
  * **Example** (Completing a transactional deferred)
  *