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

package/src/TxHashMap.ts

@@ -470,8 +470,10 @@ export const get: {
 /**
  * Sets the value for the specified key in the TxHashMap.
  *
- * **Mutation behavior**: This function mutates the original TxHashMap by updating
- * its internal state. It does not return a new TxHashMap reference.
+ * **Details**
+ *
+ * This function mutates the original TxHashMap by updating its internal state.
+ * It does not return a new TxHashMap reference.
  *
  * **Example** (Setting values)
  *
@@ -506,8 +508,10 @@ export const set: {
   /**
    * Sets the value for the specified key in the TxHashMap.
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by updating
-   * its internal state. It does not return a new TxHashMap reference.
+   * **Details**
+   *
+   * This function mutates the original TxHashMap by updating its internal state.
+   * It does not return a new TxHashMap reference.
    *
    * **Example** (Setting values)
    *
@@ -542,8 +546,10 @@ export const set: {
   /**
    * Sets the value for the specified key in the TxHashMap.
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by updating
-   * its internal state. It does not return a new TxHashMap reference.
+   * **Details**
+   *
+   * This function mutates the original TxHashMap by updating its internal state.
+   * It does not return a new TxHashMap reference.
    *
    * **Example** (Setting values)
    *
@@ -689,8 +695,10 @@ export const has: {
 /**
  * Removes the specified key from the TxHashMap.
  *
- * **Mutation behavior**: This function mutates the original TxHashMap by removing
- * the specified key-value pair. It does not return a new TxHashMap reference.
+ * **Details**
+ *
+ * This function mutates the original TxHashMap by removing the specified
+ * key-value pair. It does not return a new TxHashMap reference.
  *
  * **Example** (Removing keys)
  *
@@ -728,8 +736,10 @@ export const remove: {
   /**
    * Removes the specified key from the TxHashMap.
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by removing
-   * the specified key-value pair. It does not return a new TxHashMap reference.
+   * **Details**
+   *
+   * This function mutates the original TxHashMap by removing the specified
+   * key-value pair. It does not return a new TxHashMap reference.
    *
    * **Example** (Removing keys)
    *
@@ -767,8 +777,10 @@ export const remove: {
   /**
    * Removes the specified key from the TxHashMap.
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by removing
-   * the specified key-value pair. It does not return a new TxHashMap reference.
+   * **Details**
+   *
+   * This function mutates the original TxHashMap by removing the specified
+   * key-value pair. It does not return a new TxHashMap reference.
    *
    * **Example** (Removing keys)
    *
@@ -819,8 +831,10 @@ export const remove: {
 /**
  * Removes all entries from the TxHashMap.
  *
- * **Mutation behavior**: This function mutates the original TxHashMap by clearing
- * all key-value pairs. It does not return a new TxHashMap reference.
+ * **Details**
+ *
+ * This function mutates the original TxHashMap by clearing all key-value pairs.
+ * It does not return a new TxHashMap reference.
  *
  * **Example** (Clearing all entries)
  *
@@ -957,13 +971,12 @@ export const isNonEmpty = <K, V>(self: TxHashMap<K, V>): Effect.Effect<boolean>
   Effect.map(isEmpty(self), (empty) => !empty)
 
 /**
- * Updates the value for the specified key if it exists, returning the previous
- * value in `Some`.
+ * Updates the value for the specified key if it exists, returning the previous value in `Some`; returns `None` and leaves the map unchanged when the key is absent.
  *
- * Returns `None` and leaves the map unchanged when the key is absent.
+ * **Details**
  *
- * **Mutation behavior**: This function mutates the original TxHashMap by updating
- * the value at the specified key. It does not return a new TxHashMap reference.
+ * This function mutates the original TxHashMap by updating the value at the
+ * specified key. It does not return a new TxHashMap reference.
  *
  * **Example** (Updating existing values)
  *
@@ -1005,13 +1018,12 @@ export const isNonEmpty = <K, V>(self: TxHashMap<K, V>): Effect.Effect<boolean>
  */
 export const modify: {
   /**
-   * Updates the value for the specified key if it exists, returning the previous
-   * value in `Some`.
+   * Updates the value for the specified key if it exists, returning the previous value in `Some`; returns `None` and leaves the map unchanged when the key is absent.
    *
-   * Returns `None` and leaves the map unchanged when the key is absent.
+   * **Details**
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by updating
-   * the value at the specified key. It does not return a new TxHashMap reference.
+   * This function mutates the original TxHashMap by updating the value at the
+   * specified key. It does not return a new TxHashMap reference.
    *
    * **Example** (Updating existing values)
    *
@@ -1053,13 +1065,12 @@ export const modify: {
    */
   <K, V>(key: K, f: (value: V) => V): (self: TxHashMap<K, V>) => Effect.Effect<Option.Option<V>>
   /**
-   * Updates the value for the specified key if it exists, returning the previous
-   * value in `Some`.
+   * Updates the value for the specified key if it exists, returning the previous value in `Some`; returns `None` and leaves the map unchanged when the key is absent.
    *
-   * Returns `None` and leaves the map unchanged when the key is absent.
+   * **Details**
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by updating
-   * the value at the specified key. It does not return a new TxHashMap reference.
+   * This function mutates the original TxHashMap by updating the value at the
+   * specified key. It does not return a new TxHashMap reference.
    *
    * **Example** (Updating existing values)
    *
@@ -1122,9 +1133,11 @@ export const modify: {
 /**
  * Updates the value for the specified key using an Option-based update function.
  *
- * **Mutation behavior**: This function mutates the original TxHashMap by updating,
- * adding, or removing the key-value pair based on the function result. It does not
- * return a new TxHashMap reference.
+ * **Details**
+ *
+ * This function mutates the original TxHashMap by updating, adding, or removing
+ * the key-value pair based on the function result. It does not return a new
+ * TxHashMap reference.
  *
  * **Example** (Updating values with Option)
  *
@@ -1173,9 +1186,11 @@ export const modifyAt: {
   /**
    * Updates the value for the specified key using an Option-based update function.
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by updating,
-   * adding, or removing the key-value pair based on the function result. It does not
-   * return a new TxHashMap reference.
+   * **Details**
+   *
+   * This function mutates the original TxHashMap by updating, adding, or removing
+   * the key-value pair based on the function result. It does not return a new
+   * TxHashMap reference.
    *
    * **Example** (Updating values with Option)
    *
@@ -1224,9 +1239,11 @@ export const modifyAt: {
   /**
    * Updates the value for the specified key using an Option-based update function.
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by updating,
-   * adding, or removing the key-value pair based on the function result. It does not
-   * return a new TxHashMap reference.
+   * **Details**
+   *
+   * This function mutates the original TxHashMap by updating, adding, or removing
+   * the key-value pair based on the function result. It does not return a new
+   * TxHashMap reference.
    *
    * **Example** (Updating values with Option)
    *
@@ -1455,8 +1472,10 @@ export const snapshot = <K, V>(
  * Merges another HashMap into this TxHashMap. If both maps contain the same key,
  * the value from the other map will be used.
  *
- * **Mutation behavior**: This function mutates the original TxHashMap by merging
- * the provided HashMap into it. It does not return a new TxHashMap reference.
+ * **Details**
+ *
+ * This function mutates the original TxHashMap by merging the provided HashMap
+ * into it. It does not return a new TxHashMap reference.
  *
  * **Example** (Merging HashMaps)
  *
@@ -1504,8 +1523,10 @@ export const union: {
    * Merges another HashMap into this TxHashMap. If both maps contain the same key,
    * the value from the other map will be used.
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by merging
-   * the provided HashMap into it. It does not return a new TxHashMap reference.
+   * **Details**
+   *
+   * This function mutates the original TxHashMap by merging the provided HashMap
+   * into it. It does not return a new TxHashMap reference.
    *
    * **Example** (Merging HashMaps)
    *
@@ -1553,8 +1574,10 @@ export const union: {
    * Merges another HashMap into this TxHashMap. If both maps contain the same key,
    * the value from the other map will be used.
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by merging
-   * the provided HashMap into it. It does not return a new TxHashMap reference.
+   * **Details**
+   *
+   * This function mutates the original TxHashMap by merging the provided HashMap
+   * into it. It does not return a new TxHashMap reference.
    *
    * **Example** (Merging HashMaps)
    *
@@ -1609,8 +1632,10 @@ export const union: {
 /**
  * Removes multiple keys from the TxHashMap.
  *
- * **Mutation behavior**: This function mutates the original TxHashMap by removing
- * all specified keys. It does not return a new TxHashMap reference.
+ * **Details**
+ *
+ * This function mutates the original TxHashMap by removing all specified keys.
+ * It does not return a new TxHashMap reference.
  *
  * **Example** (Removing multiple keys)
  *
@@ -1653,8 +1678,10 @@ export const removeMany: {
   /**
    * Removes multiple keys from the TxHashMap.
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by removing
-   * all specified keys. It does not return a new TxHashMap reference.
+   * **Details**
+   *
+   * This function mutates the original TxHashMap by removing all specified keys.
+   * It does not return a new TxHashMap reference.
    *
    * **Example** (Removing multiple keys)
    *
@@ -1697,8 +1724,10 @@ export const removeMany: {
   /**
    * Removes multiple keys from the TxHashMap.
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by removing
-   * all specified keys. It does not return a new TxHashMap reference.
+   * **Details**
+   *
+   * This function mutates the original TxHashMap by removing all specified keys.
+   * It does not return a new TxHashMap reference.
    *
    * **Example** (Removing multiple keys)
    *
@@ -1747,8 +1776,10 @@ export const removeMany: {
 /**
  * Sets multiple key-value pairs in the TxHashMap.
  *
- * **Mutation behavior**: This function mutates the original TxHashMap by setting
- * all provided key-value pairs. It does not return a new TxHashMap reference.
+ * **Details**
+ *
+ * This function mutates the original TxHashMap by setting all provided key-value
+ * pairs. It does not return a new TxHashMap reference.
  *
  * **Example** (Setting multiple entries)
  *
@@ -1806,8 +1837,10 @@ export const setMany: {
   /**
    * Sets multiple key-value pairs in the TxHashMap.
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by setting
-   * all provided key-value pairs. It does not return a new TxHashMap reference.
+   * **Details**
+   *
+   * This function mutates the original TxHashMap by setting all provided key-value
+   * pairs. It does not return a new TxHashMap reference.
    *
    * **Example** (Setting multiple entries)
    *
@@ -1865,8 +1898,10 @@ export const setMany: {
   /**
    * Sets multiple key-value pairs in the TxHashMap.
    *
-   * **Mutation behavior**: This function mutates the original TxHashMap by setting
-   * all provided key-value pairs. It does not return a new TxHashMap reference.
+   * **Details**
+   *
+   * This function mutates the original TxHashMap by setting all provided key-value
+   * pairs. It does not return a new TxHashMap reference.
    *
    * **Example** (Setting multiple entries)
    *
@@ -1966,6 +2001,8 @@ export const isTxHashMap = <K, V>(value: unknown): value is TxHashMap<K, V> => {
 /**
  * Looks up the value for the specified key using a caller-supplied hash.
  *
+ * **Gotchas**
+ *
  * The supplied hash must be the hash for the same key, such as a precomputed
  * `Hash.hash(key)` value. If the hash does not match the key, an existing entry
  * may not be found.
@@ -2007,6 +2044,8 @@ export const getHash: {
   /**
    * Looks up the value for the specified key using a caller-supplied hash.
    *
+   * **Gotchas**
+   *
    * The supplied hash must be the hash for the same key, such as a precomputed
    * `Hash.hash(key)` value. If the hash does not match the key, an existing entry
    * may not be found.
@@ -2048,6 +2087,8 @@ export const getHash: {
   /**
    * Looks up the value for the specified key using a caller-supplied hash.
    *
+   * **Gotchas**
+   *
    * The supplied hash must be the hash for the same key, such as a precomputed
    * `Hash.hash(key)` value. If the hash does not match the key, an existing entry
    * may not be found.
@@ -2098,6 +2139,8 @@ export const getHash: {
 /**
  * Checks whether the specified key has an entry using a caller-supplied hash.
  *
+ * **Gotchas**
+ *
  * The supplied hash must be the hash for the same key, such as a precomputed
  * `Hash.hash(key)` value. If the hash does not match the key, an existing entry
  * may not be found.
@@ -2148,6 +2191,8 @@ export const hasHash: {
   /**
    * Checks whether the specified key has an entry using a caller-supplied hash.
    *
+   * **Gotchas**
+   *
    * The supplied hash must be the hash for the same key, such as a precomputed
    * `Hash.hash(key)` value. If the hash does not match the key, an existing entry
    * may not be found.
@@ -2198,6 +2243,8 @@ export const hasHash: {
   /**
    * Checks whether the specified key has an entry using a caller-supplied hash.
    *
+   * **Gotchas**
+   *
    * The supplied hash must be the hash for the same key, such as a precomputed
    * `Hash.hash(key)` value. If the hash does not match the key, an existing entry
    * may not be found.
@@ -2257,8 +2304,10 @@ export const hasHash: {
 /**
  * Transforms all values in the TxHashMap using the provided function, preserving keys.
  *
- * **Return behavior**: This function returns a new TxHashMap reference with the
- * transformed values. The original TxHashMap is not modified.
+ * **Details**
+ *
+ * This function returns a new TxHashMap reference with the transformed values.
+ * The original TxHashMap is not modified.
  *
  * **Example** (Mapping values)
  *
@@ -2304,8 +2353,10 @@ export const map: {
   /**
    * Transforms all values in the TxHashMap using the provided function, preserving keys.
    *
-   * **Return behavior**: This function returns a new TxHashMap reference with the
-   * transformed values. The original TxHashMap is not modified.
+   * **Details**
+   *
+   * This function returns a new TxHashMap reference with the transformed values.
+   * The original TxHashMap is not modified.
    *
    * **Example** (Mapping values)
    *
@@ -2351,8 +2402,10 @@ export const map: {
   /**
    * Transforms all values in the TxHashMap using the provided function, preserving keys.
    *
-   * **Return behavior**: This function returns a new TxHashMap reference with the
-   * transformed values. The original TxHashMap is not modified.
+   * **Details**
+   *
+   * This function returns a new TxHashMap reference with the transformed values.
+   * The original TxHashMap is not modified.
    *
    * **Example** (Mapping values)
    *
@@ -2411,8 +2464,10 @@ export const map: {
 /**
  * Filters the TxHashMap to keep only entries that satisfy the provided predicate.
  *
- * **Return behavior**: This function returns a new TxHashMap reference containing
- * only the entries that match the condition. The original TxHashMap is not modified.
+ * **Details**
+ *
+ * This function returns a new TxHashMap reference containing only the entries
+ * that match the condition. The original TxHashMap is not modified.
  *
  * **Example** (Filtering entries)
  *
@@ -2461,8 +2516,10 @@ export const filter: {
   /**
    * Filters the TxHashMap to keep only entries that satisfy the provided predicate.
    *
-   * **Return behavior**: This function returns a new TxHashMap reference containing
-   * only the entries that match the condition. The original TxHashMap is not modified.
+   * **Details**
+   *
+   * This function returns a new TxHashMap reference containing only the entries
+   * that match the condition. The original TxHashMap is not modified.
    *
    * **Example** (Filtering entries)
    *
@@ -2511,8 +2568,10 @@ export const filter: {
   /**
    * Filters the TxHashMap to keep only entries that satisfy the provided predicate.
    *
-   * **Return behavior**: This function returns a new TxHashMap reference containing
-   * only the entries that match the condition. The original TxHashMap is not modified.
+   * **Details**
+   *
+   * This function returns a new TxHashMap reference containing only the entries
+   * that match the condition. The original TxHashMap is not modified.
    *
    * **Example** (Filtering entries)
    *
@@ -2561,8 +2620,10 @@ export const filter: {
   /**
    * Filters the TxHashMap to keep only entries that satisfy the provided predicate.
    *
-   * **Return behavior**: This function returns a new TxHashMap reference containing
-   * only the entries that match the condition. The original TxHashMap is not modified.
+   * **Details**
+   *
+   * This function returns a new TxHashMap reference containing only the entries
+   * that match the condition. The original TxHashMap is not modified.
    *
    * **Example** (Filtering entries)
    *
@@ -2611,8 +2672,10 @@ export const filter: {
   /**
    * Filters the TxHashMap to keep only entries that satisfy the provided predicate.
    *
-   * **Return behavior**: This function returns a new TxHashMap reference containing
-   * only the entries that match the condition. The original TxHashMap is not modified.
+   * **Details**
+   *
+   * This function returns a new TxHashMap reference containing only the entries
+   * that match the condition. The original TxHashMap is not modified.
    *
    * **Example** (Filtering entries)
    *
@@ -2852,8 +2915,10 @@ export const reduce: {
  * Combines filtering and mapping in a single operation. Applies a filter to each
  * entry, keeping only successful results and transforming them.
  *
- * **Return behavior**: This function returns a new TxHashMap reference containing
- * only the transformed entries that succeeded. The original TxHashMap is not modified.
+ * **Details**
+ *
+ * This function returns a new TxHashMap reference containing only the transformed
+ * entries that succeeded. The original TxHashMap is not modified.
  *
  * **Example** (Filtering and mapping entries)
  *
@@ -2911,8 +2976,10 @@ export const filterMap: {
    * Combines filtering and mapping in a single operation. Applies a filter to each
    * entry, keeping only successful results and transforming them.
    *
-   * **Return behavior**: This function returns a new TxHashMap reference containing
-   * only the transformed entries that succeeded. The original TxHashMap is not modified.
+   * **Details**
+   *
+   * This function returns a new TxHashMap reference containing only the transformed
+   * entries that succeeded. The original TxHashMap is not modified.
    *
    * **Example** (Filtering and mapping entries)
    *
@@ -2970,8 +3037,10 @@ export const filterMap: {
    * Combines filtering and mapping in a single operation. Applies a filter to each
    * entry, keeping only successful results and transforming them.
    *
-   * **Return behavior**: This function returns a new TxHashMap reference containing
-   * only the transformed entries that succeeded. The original TxHashMap is not modified.
+   * **Details**
+   *
+   * This function returns a new TxHashMap reference containing only the transformed
+   * entries that succeeded. The original TxHashMap is not modified.
    *
    * **Example** (Filtering and mapping entries)
    *
@@ -3729,8 +3798,10 @@ export const forEach: {
 /**
  * Effectfully maps each entry to a `TxHashMap` and flattens the produced maps.
  *
- * **Return behavior**: This function returns a new TxHashMap reference with the
- * flattened results. The original TxHashMap is not modified.
+ * **Details**
+ *
+ * This function returns a new TxHashMap reference with the flattened results.
+ * The original TxHashMap is not modified.
  *
  * **Example** (Flat mapping entries)
  *
@@ -3781,8 +3852,10 @@ export const flatMap: {
   /**
    * Effectfully maps each entry to a `TxHashMap` and flattens the produced maps.
    *
-   * **Return behavior**: This function returns a new TxHashMap reference with the
-   * flattened results. The original TxHashMap is not modified.
+   * **Details**
+   *
+   * This function returns a new TxHashMap reference with the flattened results.
+   * The original TxHashMap is not modified.
    *
    * **Example** (Flat mapping entries)
    *
@@ -3833,8 +3906,10 @@ export const flatMap: {
   /**
    * Effectfully maps each entry to a `TxHashMap` and flattens the produced maps.
    *
-   * **Return behavior**: This function returns a new TxHashMap reference with the
-   * flattened results. The original TxHashMap is not modified.
+   * **Details**
+   *
+   * This function returns a new TxHashMap reference with the flattened results.
+   * The original TxHashMap is not modified.
    *
    * **Example** (Flat mapping entries)
    *
@@ -3896,8 +3971,10 @@ export const flatMap: {
       const result = yield* empty</**
        * Effectfully maps each entry to a `TxHashMap` and flattens the produced maps.
        *
-       * **Return behavior**: This function returns a new TxHashMap reference with the
-       * flattened results. The original TxHashMap is not modified.
+       * **Details**
+       *
+       * This function returns a new TxHashMap reference with the flattened results.
+       * The original TxHashMap is not modified.
        *
        * **Example** (Flat mapping entries)
        *
@@ -3947,8 +4024,10 @@ export const flatMap: {
       K, /**
        * Effectfully maps each entry to a `TxHashMap` and flattens the produced maps.
        *
-       * **Return behavior**: This function returns a new TxHashMap reference with the
-       * flattened results. The original TxHashMap is not modified.
+       * **Details**
+       *
+       * This function returns a new TxHashMap reference with the flattened results.
+       * The original TxHashMap is not modified.
        *
        * **Example** (Flat mapping entries)
        *
@@ -4011,8 +4090,10 @@ export const flatMap: {
 /**
  * Removes all None values from a TxHashMap containing Option values.
  *
- * **Return behavior**: This function returns a new TxHashMap reference with only
- * the Some values unwrapped. The original TxHashMap is not modified.
+ * **Details**
+ *
+ * This function returns a new TxHashMap reference with only the Some values
+ * unwrapped. The original TxHashMap is not modified.
  *
  * **Example** (Compacting optional values)
  *