effect 4.0.0-beta.66 → 4.0.0-beta.68

package/dist/TxHashSet.d.ts

@@ -1,4 +1,24 @@
 /**
+ * The `TxHashSet` module provides a transactional hash set for storing unique
+ * values inside Effect transactions. A `TxHashSet<A>` wraps a `HashSet<A>` in a
+ * transactional reference, so reads and writes can be composed with other
+ * transactional operations and committed atomically.
+ *
+ * **Common tasks**
+ *
+ * - Create transactional sets with {@link empty}, {@link make}, or {@link fromIterable}
+ * - Mutate an existing set with {@link add}, {@link remove}, and {@link clear}
+ * - Query membership and size with {@link has}, {@link size}, and {@link isEmpty}
+ * - Derive new sets with {@link map}, {@link filter}, {@link union}, {@link intersection}, and {@link difference}
+ * - Fold or collect values with {@link reduce} and {@link toHashSet}
+ *
+ * **Gotchas**
+ *
+ * - Mutation operations update the same transactional set; transform operations
+ *   return a new `TxHashSet`
+ * - Operations are `Effect` values and must be yielded, piped, or run to take effect
+ * - Use `Effect.tx` when several operations must observe and commit one atomic transaction
+ *
  * @since 2.0.0
  */
 import * as Effect from "./Effect.ts";
@@ -26,7 +46,8 @@ declare const TypeId = "~effect/transactions/TxHashSet";
  * - The original TxHashSet remains unchanged
  * - Examples: `union`, `intersection`, `difference`, `map`, `filter`
  *
- * @example
+ * **Example** (Using transactional hash sets)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -55,8 +76,8 @@ declare const TypeId = "~effect/transactions/TxHashSet";
  * })
  * ```
  *
- * @since 2.0.0
  * @category models
+ * @since 4.0.0
  */
 export interface TxHashSet<in out V> extends Inspectable, Pipeable {
     readonly [TypeId]: typeof TypeId;
@@ -66,7 +87,8 @@ export interface TxHashSet<in out V> extends Inspectable, Pipeable {
  * The TxHashSet namespace contains type-level utilities and helper types
  * for working with TxHashSet instances.
  *
- * @example
+ * **Example** (Extracting value types inside transactions)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -84,34 +106,39 @@ export interface TxHashSet<in out V> extends Inspectable, Pipeable {
  * })
  * ```
  *
- * @since 2.0.0
- * @category models
+ * @since 4.0.0
  */
 export declare namespace TxHashSet {
     /**
-     * @example
+     * Extracts the value type from a `TxHashSet` type.
+     *
+     * **Example** (Extracting a TxHashSet value type)
+     *
      * ```ts
-     * import { TxHashSet } from "effect"
+     * import type { TxHashSet } from "effect"
      *
-     * const fruits = TxHashSet.make("apple", "banana", "cherry")
+     * type FruitSet = TxHashSet.TxHashSet<"apple" | "banana" | "cherry">
      *
      * // Extract the value type
-     * type Fruit = TxHashSet.TxHashSet.Value<typeof fruits> // string
+     * type Fruit = TxHashSet.TxHashSet.Value<FruitSet> // "apple" | "banana" | "cherry"
      *
      * const processFruit = (fruit: Fruit) => {
      *   return `Processing ${fruit}`
      * }
+     *
+     * console.log(processFruit("apple")) // Processing apple
      * ```
      *
-     * @since 2.0.0
      * @category type-level
+     * @since 4.0.0
      */
     type Value<T> = T extends TxHashSet<infer V> ? V : never;
 }
 /**
  * Creates an empty TxHashSet.
  *
- * @example
+ * **Example** (Creating an empty transactional hash set)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -128,14 +155,15 @@ export declare namespace TxHashSet {
  * })
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const empty: <V = never>() => Effect.Effect<TxHashSet<V>>;
 /**
  * Creates a TxHashSet from a variable number of values.
  *
- * @example
+ * **Example** (Creating transactional hash sets from values)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -151,14 +179,15 @@ export declare const empty: <V = never>() => Effect.Effect<TxHashSet<V>>;
  * })
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const make: <Values extends ReadonlyArray<any>>(...values: Values) => Effect.Effect<TxHashSet<Values[number]>>;
 /**
  * Creates a TxHashSet from an iterable collection of values.
  *
- * @example
+ * **Example** (Creating a transactional hash set from an iterable)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -171,21 +200,21 @@ export declare const make: <Values extends ReadonlyArray<any>>(...values: Values
  *
  *   const fromString = yield* TxHashSet.fromIterable("hello")
  *   const values = yield* TxHashSet.toHashSet(fromString)
- *   console.log(Array.from(values)) // ["h", "e", "l", "o"]
+ *   console.log(Array.from(values).sort()) // ["e", "h", "l", "o"]
  * })
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const fromIterable: <V>(values: Iterable<V>) => Effect.Effect<TxHashSet<V>>;
 /**
  * Creates a TxHashSet from an existing HashSet.
  *
- * @example
+ * **Example** (Creating a transactional hash set from a HashSet)
+ *
  * ```ts
- * import { Effect, TxHashSet } from "effect"
- * import * as HashSet from "effect/HashSet"
+ * import { Effect, HashSet, TxHashSet } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const hashSet = HashSet.make("x", "y", "z")
@@ -201,17 +230,17 @@ export declare const fromIterable: <V>(values: Iterable<V>) => Effect.Effect<TxH
  * })
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export declare const fromHashSet: <V>(hashSet: HashSet.HashSet<V>) => Effect.Effect<TxHashSet<V>>;
 /**
  * Checks if a value is a TxHashSet.
  *
- * @example
+ * **Example** (Checking for a TxHashSet)
+ *
  * ```ts
- * import { Effect, TxHashSet } from "effect"
- * import * as HashSet from "effect/HashSet"
+ * import { Effect, HashSet, TxHashSet } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const txSet = yield* TxHashSet.make(1, 2, 3)
@@ -225,8 +254,8 @@ export declare const fromHashSet: <V>(hashSet: HashSet.HashSet<V>) => Effect.Eff
  * })
  * ```
  *
- * @since 2.0.0
  * @category guards
+ * @since 4.0.0
  */
 export declare const isTxHashSet: (u: unknown) => u is TxHashSet<unknown>;
 /**
@@ -235,7 +264,8 @@ export declare const isTxHashSet: (u: unknown) => u is TxHashSet<unknown>;
  * **Mutation behavior**: This function mutates the original TxHashSet by adding
  * the specified value. It does not return a new TxHashSet reference.
  *
- * @example
+ * **Example** (Adding values)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -252,8 +282,8 @@ export declare const isTxHashSet: (u: unknown) => u is TxHashSet<unknown>;
  * })
  * ```
  *
- * @since 2.0.0
  * @category mutations
+ * @since 2.0.0
  */
 export declare const add: {
     /**
@@ -262,7 +292,8 @@ export declare const add: {
      * **Mutation behavior**: This function mutates the original TxHashSet by adding
      * the specified value. It does not return a new TxHashSet reference.
      *
-     * @example
+     * **Example** (Adding values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -279,8 +310,8 @@ export declare const add: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category mutations
+     * @since 2.0.0
      */
     <V>(value: V): (self: TxHashSet<V>) => Effect.Effect<void>;
     /**
@@ -289,7 +320,8 @@ export declare const add: {
      * **Mutation behavior**: This function mutates the original TxHashSet by adding
      * the specified value. It does not return a new TxHashSet reference.
      *
-     * @example
+     * **Example** (Adding values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -306,8 +338,8 @@ export declare const add: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category mutations
+     * @since 2.0.0
      */
     <V>(self: TxHashSet<V>, value: V): Effect.Effect<void>;
 };
@@ -317,7 +349,8 @@ export declare const add: {
  * **Mutation behavior**: This function mutates the original TxHashSet by removing
  * the specified value. It does not return a new TxHashSet reference.
  *
- * @example
+ * **Example** (Removing values)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -335,8 +368,8 @@ export declare const add: {
  * })
  * ```
  *
- * @since 2.0.0
  * @category mutations
+ * @since 2.0.0
  */
 export declare const remove: {
     /**
@@ -345,7 +378,8 @@ export declare const remove: {
      * **Mutation behavior**: This function mutates the original TxHashSet by removing
      * the specified value. It does not return a new TxHashSet reference.
      *
-     * @example
+     * **Example** (Removing values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -363,8 +397,8 @@ export declare const remove: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category mutations
+     * @since 2.0.0
      */
     <V>(value: V): (self: TxHashSet<V>) => Effect.Effect<boolean>;
     /**
@@ -373,7 +407,8 @@ export declare const remove: {
      * **Mutation behavior**: This function mutates the original TxHashSet by removing
      * the specified value. It does not return a new TxHashSet reference.
      *
-     * @example
+     * **Example** (Removing values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -391,15 +426,16 @@ export declare const remove: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category mutations
+     * @since 2.0.0
      */
     <V>(self: TxHashSet<V>, value: V): Effect.Effect<boolean>;
 };
 /**
  * Checks if the TxHashSet contains the specified value.
  *
- * @example
+ * **Example** (Checking membership)
+ *
  * ```ts
  * import { Effect, Equal, Hash, TxHashSet } from "effect"
  *
@@ -427,14 +463,15 @@ export declare const remove: {
  * })
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 2.0.0
  */
 export declare const has: {
     /**
      * Checks if the TxHashSet contains the specified value.
      *
-     * @example
+     * **Example** (Checking membership)
+     *
      * ```ts
      * import { Effect, Equal, Hash, TxHashSet } from "effect"
      *
@@ -462,14 +499,15 @@ export declare const has: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <V>(value: V): (self: TxHashSet<V>) => Effect.Effect<boolean>;
     /**
      * Checks if the TxHashSet contains the specified value.
      *
-     * @example
+     * **Example** (Checking membership)
+     *
      * ```ts
      * import { Effect, Equal, Hash, TxHashSet } from "effect"
      *
@@ -497,15 +535,16 @@ export declare const has: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <V>(self: TxHashSet<V>, value: V): Effect.Effect<boolean>;
 };
 /**
  * Returns the number of values in the TxHashSet.
  *
- * @example
+ * **Example** (Getting the set size)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -521,14 +560,15 @@ export declare const has: {
  * })
  * ```
  *
- * @since 2.0.0
  * @category getters
+ * @since 2.0.0
  */
 export declare const size: <V>(self: TxHashSet<V>) => Effect.Effect<number>;
 /**
  * Checks if the TxHashSet is empty.
  *
- * @example
+ * **Example** (Checking whether a set is empty)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -541,8 +581,8 @@ export declare const size: <V>(self: TxHashSet<V>) => Effect.Effect<number>;
  * })
  * ```
  *
- * @since 2.0.0
  * @category getters
+ * @since 2.0.0
  */
 export declare const isEmpty: <V>(self: TxHashSet<V>) => Effect.Effect<boolean>;
 /**
@@ -551,7 +591,8 @@ export declare const isEmpty: <V>(self: TxHashSet<V>) => Effect.Effect<boolean>;
  * **Mutation behavior**: This function mutates the original TxHashSet by clearing
  * all values. It does not return a new TxHashSet reference.
  *
- * @example
+ * **Example** (Clearing all values)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -565,14 +606,15 @@ export declare const isEmpty: <V>(self: TxHashSet<V>) => Effect.Effect<boolean>;
  * })
  * ```
  *
- * @since 2.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export declare const clear: <V>(self: TxHashSet<V>) => Effect.Effect<void>;
 /**
  * Creates the union of two TxHashSets, returning a new TxHashSet.
  *
- * @example
+ * **Example** (Combining sets with union)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -587,14 +629,15 @@ export declare const clear: <V>(self: TxHashSet<V>) => Effect.Effect<void>;
  * })
  * ```
  *
- * @since 2.0.0
  * @category combinators
+ * @since 2.0.0
  */
 export declare const union: {
     /**
      * Creates the union of two TxHashSets, returning a new TxHashSet.
      *
-     * @example
+     * **Example** (Combining sets with union)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -609,14 +652,15 @@ export declare const union: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <V1>(that: TxHashSet<V1>): <V0>(self: TxHashSet<V0>) => Effect.Effect<TxHashSet<V1 | V0>>;
     /**
      * Creates the union of two TxHashSets, returning a new TxHashSet.
      *
-     * @example
+     * **Example** (Combining sets with union)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -631,15 +675,16 @@ export declare const union: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <V0, V1>(self: TxHashSet<V0>, that: TxHashSet<V1>): Effect.Effect<TxHashSet<V0 | V1>>;
 };
 /**
  * Creates the intersection of two TxHashSets, returning a new TxHashSet.
  *
- * @example
+ * **Example** (Finding common values)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -654,14 +699,15 @@ export declare const union: {
  * })
  * ```
  *
- * @since 2.0.0
  * @category combinators
+ * @since 2.0.0
  */
 export declare const intersection: {
     /**
      * Creates the intersection of two TxHashSets, returning a new TxHashSet.
      *
-     * @example
+     * **Example** (Finding common values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -676,14 +722,15 @@ export declare const intersection: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <V1>(that: TxHashSet<V1>): <V0>(self: TxHashSet<V0>) => Effect.Effect<TxHashSet<V1 & V0>>;
     /**
      * Creates the intersection of two TxHashSets, returning a new TxHashSet.
      *
-     * @example
+     * **Example** (Finding common values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -698,15 +745,16 @@ export declare const intersection: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <V0, V1>(self: TxHashSet<V0>, that: TxHashSet<V1>): Effect.Effect<TxHashSet<V0 & V1>>;
 };
 /**
  * Creates the difference of two TxHashSets (elements in the first set that are not in the second), returning a new TxHashSet.
  *
- * @example
+ * **Example** (Finding values absent from another set)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -721,14 +769,15 @@ export declare const intersection: {
  * })
  * ```
  *
- * @since 2.0.0
  * @category combinators
+ * @since 2.0.0
  */
 export declare const difference: {
     /**
      * Creates the difference of two TxHashSets (elements in the first set that are not in the second), returning a new TxHashSet.
      *
-     * @example
+     * **Example** (Finding values absent from another set)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -743,14 +792,15 @@ export declare const difference: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <V1>(that: TxHashSet<V1>): <V0>(self: TxHashSet<V0>) => Effect.Effect<TxHashSet<V0>>;
     /**
      * Creates the difference of two TxHashSets (elements in the first set that are not in the second), returning a new TxHashSet.
      *
-     * @example
+     * **Example** (Finding values absent from another set)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -765,15 +815,16 @@ export declare const difference: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <V0, V1>(self: TxHashSet<V0>, that: TxHashSet<V1>): Effect.Effect<TxHashSet<V0>>;
 };
 /**
  * Checks if a TxHashSet is a subset of another TxHashSet.
  *
- * @example
+ * **Example** (Checking subset relationships)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -789,14 +840,15 @@ export declare const difference: {
  * })
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 4.0.0
  */
 export declare const isSubset: {
     /**
      * Checks if a TxHashSet is a subset of another TxHashSet.
      *
-     * @example
+     * **Example** (Checking subset relationships)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -812,14 +864,15 @@ export declare const isSubset: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 4.0.0
      */
     <V1>(that: TxHashSet<V1>): <V0>(self: TxHashSet<V0>) => Effect.Effect<boolean>;
     /**
      * Checks if a TxHashSet is a subset of another TxHashSet.
      *
-     * @example
+     * **Example** (Checking subset relationships)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -835,15 +888,16 @@ export declare const isSubset: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 4.0.0
      */
     <V0, V1>(self: TxHashSet<V0>, that: TxHashSet<V1>): Effect.Effect<boolean>;
 };
 /**
  * Tests whether at least one value in the TxHashSet satisfies the predicate.
  *
- * @example
+ * **Example** (Testing whether some values match)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -858,14 +912,15 @@ export declare const isSubset: {
  * })
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 4.0.0
  */
 export declare const some: {
     /**
      * Tests whether at least one value in the TxHashSet satisfies the predicate.
      *
-     * @example
+     * **Example** (Testing whether some values match)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -880,14 +935,15 @@ export declare const some: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 4.0.0
      */
     <V>(predicate: Predicate<V>): (self: TxHashSet<V>) => Effect.Effect<boolean>;
     /**
      * Tests whether at least one value in the TxHashSet satisfies the predicate.
      *
-     * @example
+     * **Example** (Testing whether some values match)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -902,15 +958,16 @@ export declare const some: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 4.0.0
      */
     <V>(self: TxHashSet<V>, predicate: Predicate<V>): Effect.Effect<boolean>;
 };
 /**
  * Tests whether all values in the TxHashSet satisfy the predicate.
  *
- * @example
+ * **Example** (Testing whether every value matches)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -925,14 +982,15 @@ export declare const some: {
  * })
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 4.0.0
  */
 export declare const every: {
     /**
      * Tests whether all values in the TxHashSet satisfy the predicate.
      *
-     * @example
+     * **Example** (Testing whether every value matches)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -947,14 +1005,15 @@ export declare const every: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 4.0.0
      */
     <V>(predicate: Predicate<V>): (self: TxHashSet<V>) => Effect.Effect<boolean>;
     /**
      * Tests whether all values in the TxHashSet satisfy the predicate.
      *
-     * @example
+     * **Example** (Testing whether every value matches)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -969,15 +1028,16 @@ export declare const every: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 4.0.0
      */
     <V>(self: TxHashSet<V>, predicate: Predicate<V>): Effect.Effect<boolean>;
 };
 /**
  * Maps each value in the TxHashSet using the provided function, returning a new TxHashSet.
  *
- * @example
+ * **Example** (Mapping values)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -997,14 +1057,15 @@ export declare const every: {
  * })
  * ```
  *
- * @since 2.0.0
  * @category mapping
+ * @since 4.0.0
  */
 export declare const map: {
     /**
      * Maps each value in the TxHashSet using the provided function, returning a new TxHashSet.
      *
-     * @example
+     * **Example** (Mapping values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -1024,14 +1085,15 @@ export declare const map: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category mapping
+     * @since 4.0.0
      */
     <V, U>(f: (value: V) => U): (self: TxHashSet<V>) => Effect.Effect<TxHashSet<U>>;
     /**
      * Maps each value in the TxHashSet using the provided function, returning a new TxHashSet.
      *
-     * @example
+     * **Example** (Mapping values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -1051,15 +1113,16 @@ export declare const map: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category mapping
+     * @since 4.0.0
      */
     <V, U>(self: TxHashSet<V>, f: (value: V) => U): Effect.Effect<TxHashSet<U>>;
 };
 /**
  * Filters the TxHashSet keeping only values that satisfy the predicate, returning a new TxHashSet.
  *
- * @example
+ * **Example** (Filtering values)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -1073,14 +1136,15 @@ export declare const map: {
  * })
  * ```
  *
- * @since 2.0.0
  * @category filtering
+ * @since 4.0.0
  */
 export declare const filter: {
     /**
      * Filters the TxHashSet keeping only values that satisfy the predicate, returning a new TxHashSet.
      *
-     * @example
+     * **Example** (Filtering values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -1094,14 +1158,15 @@ export declare const filter: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category filtering
+     * @since 4.0.0
      */
     <V, U extends V>(refinement: Refinement<NoInfer<V>, U>): (self: TxHashSet<V>) => Effect.Effect<TxHashSet<U>>;
     /**
      * Filters the TxHashSet keeping only values that satisfy the predicate, returning a new TxHashSet.
      *
-     * @example
+     * **Example** (Filtering values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -1115,14 +1180,15 @@ export declare const filter: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category filtering
+     * @since 4.0.0
      */
     <V>(predicate: Predicate<NoInfer<V>>): (self: TxHashSet<V>) => Effect.Effect<TxHashSet<V>>;
     /**
      * Filters the TxHashSet keeping only values that satisfy the predicate, returning a new TxHashSet.
      *
-     * @example
+     * **Example** (Filtering values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -1136,14 +1202,15 @@ export declare const filter: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category filtering
+     * @since 4.0.0
      */
     <V, U extends V>(self: TxHashSet<V>, refinement: Refinement<V, U>): Effect.Effect<TxHashSet<U>>;
     /**
      * Filters the TxHashSet keeping only values that satisfy the predicate, returning a new TxHashSet.
      *
-     * @example
+     * **Example** (Filtering values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -1157,15 +1224,16 @@ export declare const filter: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category filtering
+     * @since 4.0.0
      */
     <V>(self: TxHashSet<V>, predicate: Predicate<V>): Effect.Effect<TxHashSet<V>>;
 };
 /**
  * Reduces the TxHashSet to a single value by iterating through the values and applying an accumulator function.
  *
- * @example
+ * **Example** (Reducing values)
+ *
  * ```ts
  * import { Effect, TxHashSet } from "effect"
  *
@@ -1181,14 +1249,15 @@ export declare const filter: {
  * })
  * ```
  *
- * @since 2.0.0
  * @category folding
+ * @since 2.0.0
  */
 export declare const reduce: {
     /**
      * Reduces the TxHashSet to a single value by iterating through the values and applying an accumulator function.
      *
-     * @example
+     * **Example** (Reducing values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -1204,14 +1273,15 @@ export declare const reduce: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category folding
+     * @since 2.0.0
      */
     <V, U>(zero: U, f: (accumulator: U, value: V) => U): (self: TxHashSet<V>) => Effect.Effect<U>;
     /**
      * Reduces the TxHashSet to a single value by iterating through the values and applying an accumulator function.
      *
-     * @example
+     * **Example** (Reducing values)
+     *
      * ```ts
      * import { Effect, TxHashSet } from "effect"
      *
@@ -1227,18 +1297,18 @@ export declare const reduce: {
      * })
      * ```
      *
-     * @since 2.0.0
      * @category folding
+     * @since 2.0.0
      */
     <V, U>(self: TxHashSet<V>, zero: U, f: (accumulator: U, value: V) => U): Effect.Effect<U>;
 };
 /**
  * Converts the TxHashSet to an immutable HashSet snapshot.
  *
- * @example
+ * **Example** (Taking a HashSet snapshot)
+ *
  * ```ts
- * import { Effect, TxHashSet } from "effect"
- * import * as HashSet from "effect/HashSet"
+ * import { Effect, HashSet, TxHashSet } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const txSet = yield* TxHashSet.make("x", "y", "z")
@@ -1254,8 +1324,8 @@ export declare const reduce: {
  * })
  * ```
  *
+ * @category converting
  * @since 2.0.0
- * @category conversions
  */
 export declare const toHashSet: <V>(self: TxHashSet<V>) => Effect.Effect<HashSet.HashSet<V>>;
 export {};