effect 4.0.0-beta.71 → 4.0.0-beta.72

package/src/Tuple.ts

@@ -115,8 +115,7 @@ type Indices<T extends ReadonlyArray<unknown>> = Exclude<Partial<T>["length"], T
  *
  * **Details**
  *
- * The index is constrained to valid tuple positions at the type level, and the
- * input tuple is not mutated.
+ * The index is constrained to valid tuple positions at the type level.
  *
  * **Example** (Extracting an element by index)
  *
@@ -142,8 +141,7 @@ export const get: {
    *
    * **Details**
    *
-   * The index is constrained to valid tuple positions at the type level, and the
-   * input tuple is not mutated.
+   * The index is constrained to valid tuple positions at the type level.
    *
    * **Example** (Extracting an element by index)
    *
@@ -169,8 +167,7 @@ export const get: {
    *
    * **Details**
    *
-   * The index is constrained to valid tuple positions at the type level, and the
-   * input tuple is not mutated.
+   * The index is constrained to valid tuple positions at the type level.
    *
    * **Example** (Extracting an element by index)
    *
@@ -214,8 +211,7 @@ type PickTuple<T extends ReadonlyArray<unknown>, K> = _BuildTuple<T, K>
  *
  * **Details**
  *
- * The result order matches the order of the provided indices. The input tuple is
- * not mutated; a fresh tuple is returned.
+ * The result order matches the order of the provided indices.
  *
  * **Example** (Selecting elements by index)
  *
@@ -241,8 +237,7 @@ export const pick: {
    *
    * **Details**
    *
-   * The result order matches the order of the provided indices. The input tuple is
-   * not mutated; a fresh tuple is returned.
+   * The result order matches the order of the provided indices.
    *
    * **Example** (Selecting elements by index)
    *
@@ -268,8 +263,7 @@ export const pick: {
    *
    * **Details**
    *
-   * The result order matches the order of the provided indices. The input tuple is
-   * not mutated; a fresh tuple is returned.
+   * The result order matches the order of the provided indices.
    *
    * **Example** (Selecting elements by index)
    *
@@ -307,8 +301,7 @@ type OmitTuple<T extends ReadonlyArray<unknown>, K> = _BuildTuple<T, Exclude<Ind
  *
  * **Details**
  *
- * Elements not at the specified indices are kept in their original order. The
- * input tuple is not mutated; a fresh tuple is returned.
+ * Elements not at the specified indices are kept in their original order.
  *
  * **Example** (Removing elements by index)
  *
@@ -333,8 +326,7 @@ export const omit: {
    *
    * **Details**
    *
-   * Elements not at the specified indices are kept in their original order. The
-   * input tuple is not mutated; a fresh tuple is returned.
+   * Elements not at the specified indices are kept in their original order.
    *
    * **Example** (Removing elements by index)
    *
@@ -359,8 +351,7 @@ export const omit: {
    *
    * **Details**
    *
-   * Elements not at the specified indices are kept in their original order. The
-   * input tuple is not mutated; a fresh tuple is returned.
+   * Elements not at the specified indices are kept in their original order.
    *
    * **Example** (Removing elements by index)
    *
@@ -396,8 +387,7 @@ export const omit: {
  *
  * **Details**
  *
- * The result type is `[...T, E]`, preserving all existing element types. The
- * input tuple is not mutated; a fresh tuple is returned.
+ * The result type is `[...T, E]`, preserving all existing element types.
  *
  * **Example** (Appending an element)
  *
@@ -422,8 +412,7 @@ export const appendElement: {
    *
    * **Details**
    *
-   * The result type is `[...T, E]`, preserving all existing element types. The
-   * input tuple is not mutated; a fresh tuple is returned.
+   * The result type is `[...T, E]`, preserving all existing element types.
    *
    * **Example** (Appending an element)
    *
@@ -448,8 +437,7 @@ export const appendElement: {
    *
    * **Details**
    *
-   * The result type is `[...T, E]`, preserving all existing element types. The
-   * input tuple is not mutated; a fresh tuple is returned.
+   * The result type is `[...T, E]`, preserving all existing element types.
    *
    * **Example** (Appending an element)
    *
@@ -569,7 +557,7 @@ type Evolved<T, E> = { [I in keyof T]: I extends keyof E ? (E[I] extends (...a:
  * **Details**
  *
  * Each transform function receives the current value and can return a different
- * type. The input tuple is not mutated; a fresh tuple is returned.
+ * type.
  *
  * **Example** (Transforming selected elements)
  *
@@ -604,7 +592,7 @@ export const evolve: {
    * **Details**
    *
    * Each transform function receives the current value and can return a different
-   * type. The input tuple is not mutated; a fresh tuple is returned.
+   * type.
    *
    * **Example** (Transforming selected elements)
    *
@@ -639,7 +627,7 @@ export const evolve: {
    * **Details**
    *
    * Each transform function receives the current value and can return a different
-   * type. The input tuple is not mutated; a fresh tuple is returned.
+   * type.
    *
    * **Example** (Transforming selected elements)
    *
@@ -670,7 +658,7 @@ export const evolve: {
 )
 
 /**
- * Rearranges elements of a tuple by providing an array of stringified source
+ * Renames tuple indices by providing an array of stringified source
  * indices. Each position in the array specifies which index to read from
  * (e.g., `["2", "1", "0"]` reverses a 3-element tuple).
  *
@@ -680,7 +668,7 @@ export const evolve: {
  *
  * **Details**
  *
- * The input tuple is not mutated; a fresh tuple is returned.
+ * The mapping returns a tuple in the requested index order.
  *
  * **Gotchas**
  *
@@ -704,7 +692,7 @@ export const evolve: {
  */
 export const renameIndices: {
   /**
-   * Rearranges elements of a tuple by providing an array of stringified source
+   * Renames tuple indices by providing an array of stringified source
    * indices. Each position in the array specifies which index to read from
    * (e.g., `["2", "1", "0"]` reverses a 3-element tuple).
    *
@@ -714,7 +702,7 @@ export const renameIndices: {
    *
    * **Details**
    *
-   * The input tuple is not mutated; a fresh tuple is returned.
+   * The mapping returns a tuple in the requested index order.
    *
    * **Gotchas**
    *
@@ -738,7 +726,7 @@ export const renameIndices: {
    */
   <const T extends ReadonlyArray<unknown>, const M extends { readonly [I in keyof T]?: `${keyof T & string}` }>(mapping: M): (self: T) => { [I in keyof T]: I extends keyof M ? M[I] extends keyof T ? T[M[I]] : T[I] : T[I] }
   /**
-   * Rearranges elements of a tuple by providing an array of stringified source
+   * Renames tuple indices by providing an array of stringified source
    * indices. Each position in the array specifies which index to read from
    * (e.g., `["2", "1", "0"]` reverses a 3-element tuple).
    *
@@ -748,7 +736,7 @@ export const renameIndices: {
    *
    * **Details**
    *
-   * The input tuple is not mutated; a fresh tuple is returned.
+   * The mapping returns a tuple in the requested index order.
    *
    * **Gotchas**
    *
@@ -790,8 +778,7 @@ export const renameIndices: {
  *
  * **Details**
  *
- * The lambda lets the compiler track the output type for each element. The
- * input tuple is not mutated; a fresh tuple is returned.
+ * The lambda lets the compiler track the output type for each element.
  *
  * **Gotchas**
  *
@@ -829,8 +816,7 @@ export const map: {
    *
    * **Details**
    *
-   * The lambda lets the compiler track the output type for each element. The
-   * input tuple is not mutated; a fresh tuple is returned.
+   * The lambda lets the compiler track the output type for each element.
    *
    * **Gotchas**
    *
@@ -870,8 +856,7 @@ export const map: {
    *
    * **Details**
    *
-   * The lambda lets the compiler track the output type for each element. The
-   * input tuple is not mutated; a fresh tuple is returned.
+   * The lambda lets the compiler track the output type for each element.
    *
    * **Gotchas**
    *
@@ -916,10 +901,6 @@ export const map: {
  * Use when you want to apply the same transformation to a subset of
  * positions.
  *
- * **Details**
- *
- * The input tuple is not mutated; a fresh tuple is returned.
- *
  * **Example** (Wrapping only selected elements in arrays)
  *
  * ```ts
@@ -953,10 +934,6 @@ export const mapPick: {
    * Use when you want to apply the same transformation to a subset of
    * positions.
    *
-   * **Details**
-   *
-   * The input tuple is not mutated; a fresh tuple is returned.
-   *
    * **Example** (Wrapping only selected elements in arrays)
    *
    * ```ts
@@ -992,10 +969,6 @@ export const mapPick: {
    * Use when you want to apply the same transformation to a subset of
    * positions.
    *
-   * **Details**
-   *
-   * The input tuple is not mutated; a fresh tuple is returned.
-   *
    * **Example** (Wrapping only selected elements in arrays)
    *
    * ```ts
@@ -1041,10 +1014,6 @@ export const mapPick: {
  * Use when most elements should be transformed but a few should be
  * preserved.
  *
- * **Details**
- *
- * The input tuple is not mutated; a fresh tuple is returned.
- *
  * **Example** (Wrapping all elements except one in arrays)
  *
  * ```ts
@@ -1078,10 +1047,6 @@ export const mapOmit: {
    * Use when most elements should be transformed but a few should be
    * preserved.
    *
-   * **Details**
-   *
-   * The input tuple is not mutated; a fresh tuple is returned.
-   *
    * **Example** (Wrapping all elements except one in arrays)
    *
    * ```ts
@@ -1117,10 +1082,6 @@ export const mapOmit: {
    * Use when most elements should be transformed but a few should be
    * preserved.
    *
-   * **Details**
-   *
-   * The input tuple is not mutated; a fresh tuple is returned.
-   *
    * **Example** (Wrapping all elements except one in arrays)
    *
    * ```ts
@@ -1222,7 +1183,7 @@ export const makeOrder = order.Tuple
 
 export {
   /**
-   * Checks if an array has exactly `N` elements, narrowing the type to a
+   * Checks whether an array has exactly `N` elements, narrowing the type to a
    * fixed-length tuple.
    *
    * **When to use**
@@ -1256,7 +1217,7 @@ export {
    */
   isTupleOf,
   /**
-   * Checks if an array has at least `N` elements, narrowing the type to a
+   * Checks whether an array has at least `N` elements, narrowing the type to a
    * tuple with a minimum length.
    *
    * **When to use**
@@ -1302,10 +1263,6 @@ export {
  * Use when you need to merge two tuples of the same shape, such as summing
  * counters or concatenating strings.
  *
- * **Details**
- *
- * The inputs are not mutated; a fresh tuple is returned.
- *
  * **Example** (Combining tuple elements)
  *
  * ```ts
@@ -1346,10 +1303,6 @@ export function makeCombiner<A extends ReadonlyArray<unknown>>(
  *
  * Use to fold a collection of tuples into a single summary tuple.
  *
- * **Details**
- *
- * The inputs are not mutated; a fresh tuple is returned.
- *
  * **Example** (Reducing a collection of tuples)
  *
  * ```ts

package/src/TxChunk.ts

@@ -784,7 +784,7 @@ export const size = <A>(self: TxChunk<A>): Effect.Effect<number> =>
   modify(self, (current) => [Chunk.size(current), current])
 
 /**
- * Checks if the `TxChunk` is empty.
+ * Checks whether the `TxChunk` is empty.
  *
  * **Example** (Checking for an empty chunk)
  *
@@ -811,7 +811,7 @@ export const isEmpty = <A>(self: TxChunk<A>): Effect.Effect<boolean> =>
   modify(self, (current) => [Chunk.isEmpty(current), current])
 
 /**
- * Checks if the `TxChunk` is non-empty.
+ * Checks whether the `TxChunk` is non-empty.
  *
  * **Example** (Checking for a non-empty chunk)
  *

package/src/TxHashMap.ts

@@ -360,7 +360,7 @@ export const fromIterable = <K, V>(
   })
 
 /**
- * Safely lookup the value for the specified key in the TxHashMap.
+ * Looks up the value for the specified key in the TxHashMap.
  *
  * **Example** (Looking up values safely)
  *
@@ -393,7 +393,7 @@ export const fromIterable = <K, V>(
  */
 export const get: {
   /**
-   * Safely lookup the value for the specified key in the TxHashMap.
+   * Looks up the value for the specified key in the TxHashMap.
    *
    * **Example** (Looking up values safely)
    *
@@ -426,7 +426,7 @@ export const get: {
    */
   <K1 extends K, K>(key: K1): <V>(self: TxHashMap<K, V>) => Effect.Effect<Option.Option<V>>
   /**
-   * Safely lookup the value for the specified key in the TxHashMap.
+   * Looks up the value for the specified key in the TxHashMap.
    *
    * **Example** (Looking up values safely)
    *
@@ -588,7 +588,7 @@ export const set: {
 )
 
 /**
- * Checks if the specified key exists in the TxHashMap.
+ * Checks whether the specified key exists in the TxHashMap.
  *
  * **Example** (Checking for keys)
  *
@@ -620,7 +620,7 @@ export const set: {
  */
 export const has: {
   /**
-   * Checks if the specified key exists in the TxHashMap.
+   * Checks whether the specified key exists in the TxHashMap.
    *
    * **Example** (Checking for keys)
    *
@@ -652,7 +652,7 @@ export const has: {
    */
   <K1 extends K, K>(key: K1): <V>(self: TxHashMap<K, V>) => Effect.Effect<boolean>
   /**
-   * Checks if the specified key exists in the TxHashMap.
+   * Checks whether the specified key exists in the TxHashMap.
    *
    * **Example** (Checking for keys)
    *
@@ -909,7 +909,7 @@ export const size = <K, V>(self: TxHashMap<K, V>): Effect.Effect<number> =>
   })
 
 /**
- * Checks if the TxHashMap is empty.
+ * Checks whether the TxHashMap is empty.
  *
  * **Example** (Checking for an empty map)
  *
@@ -944,7 +944,7 @@ export const isEmpty = <K, V>(self: TxHashMap<K, V>): Effect.Effect<boolean> =>
   })
 
 /**
- * Checks if the TxHashMap is non-empty.
+ * Checks whether the TxHashMap is non-empty.
  *
  * **Example** (Checking for a non-empty map)
  *
@@ -3108,7 +3108,7 @@ export const filterMap: {
 )
 
 /**
- * Checks if any entry in the TxHashMap matches the given predicate.
+ * Checks whether any entry in the TxHashMap matches the given predicate.
  *
  * **Example** (Checking entries with a predicate)
  *
@@ -3151,7 +3151,7 @@ export const filterMap: {
  */
 export const hasBy: {
   /**
-   * Checks if any entry in the TxHashMap matches the given predicate.
+   * Checks whether any entry in the TxHashMap matches the given predicate.
    *
    * **Example** (Checking entries with a predicate)
    *
@@ -3194,7 +3194,7 @@ export const hasBy: {
    */
   <K, V>(predicate: (value: V, key: K) => boolean): (self: TxHashMap<K, V>) => Effect.Effect<boolean>
   /**
-   * Checks if any entry in the TxHashMap matches the given predicate.
+   * Checks whether any entry in the TxHashMap matches the given predicate.
    *
    * **Example** (Checking entries with a predicate)
    *
@@ -3386,7 +3386,7 @@ export const findFirst: {
 )
 
 /**
- * Checks if at least one entry in the TxHashMap satisfies the given predicate.
+ * Checks whether at least one entry in the TxHashMap satisfies the given predicate.
  *
  * **Example** (Checking whether some entries match)
  *
@@ -3428,7 +3428,7 @@ export const findFirst: {
  */
 export const some: {
   /**
-   * Checks if at least one entry in the TxHashMap satisfies the given predicate.
+   * Checks whether at least one entry in the TxHashMap satisfies the given predicate.
    *
    * **Example** (Checking whether some entries match)
    *
@@ -3470,7 +3470,7 @@ export const some: {
    */
   <K, V>(predicate: (value: V, key: K) => boolean): (self: TxHashMap<K, V>) => Effect.Effect<boolean>
   /**
-   * Checks if at least one entry in the TxHashMap satisfies the given predicate.
+   * Checks whether at least one entry in the TxHashMap satisfies the given predicate.
    *
    * **Example** (Checking whether some entries match)
    *
@@ -3520,7 +3520,7 @@ export const some: {
 )
 
 /**
- * Checks if all entries in the TxHashMap satisfy the given predicate.
+ * Checks whether all entries in the TxHashMap satisfy the given predicate.
  *
  * **Example** (Checking whether every entry matches)
  *
@@ -3562,7 +3562,7 @@ export const some: {
  */
 export const every: {
   /**
-   * Checks if all entries in the TxHashMap satisfy the given predicate.
+   * Checks whether all entries in the TxHashMap satisfy the given predicate.
    *
    * **Example** (Checking whether every entry matches)
    *
@@ -3604,7 +3604,7 @@ export const every: {
    */
   <K, V>(predicate: (value: V, key: K) => boolean): (self: TxHashMap<K, V>) => Effect.Effect<boolean>
   /**
-   * Checks if all entries in the TxHashMap satisfy the given predicate.
+   * Checks whether all entries in the TxHashMap satisfy the given predicate.
    *
    * **Example** (Checking whether every entry matches)
    *
@@ -3796,7 +3796,7 @@ export const forEach: {
 )
 
 /**
- * Effectfully maps each entry to a `TxHashMap` and flattens the produced maps.
+ * Maps each entry effectfully to a `TxHashMap` and flattens the produced maps.
  *
  * **Details**
  *
@@ -3850,7 +3850,7 @@ export const forEach: {
  */
 export const flatMap: {
   /**
-   * Effectfully maps each entry to a `TxHashMap` and flattens the produced maps.
+   * Maps each entry effectfully to a `TxHashMap` and flattens the produced maps.
    *
    * **Details**
    *
@@ -3904,7 +3904,7 @@ export const flatMap: {
    */
   <A, V, K>(f: (value: V, key: K) => Effect.Effect<TxHashMap<K, A>>): (self: TxHashMap<K, V>) => Effect.Effect<TxHashMap<K, A>>
   /**
-   * Effectfully maps each entry to a `TxHashMap` and flattens the produced maps.
+   * Maps each entry effectfully to a `TxHashMap` and flattens the produced maps.
    *
    * **Details**
    *
@@ -3969,7 +3969,7 @@ export const flatMap: {
     Effect.gen(function*() {
       const currentMap = yield* TxRef.get(self.ref)
       const result = yield* empty</**
-       * Effectfully maps each entry to a `TxHashMap` and flattens the produced maps.
+       * Maps each entry effectfully to a `TxHashMap` and flattens the produced maps.
        *
        * **Details**
        *
@@ -4022,7 +4022,7 @@ export const flatMap: {
        * @since 4.0.0
        */
       K, /**
-       * Effectfully maps each entry to a `TxHashMap` and flattens the produced maps.
+       * Maps each entry effectfully to a `TxHashMap` and flattens the produced maps.
        *
        * **Details**
        *