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

package/dist/HashSet.d.ts

@@ -1,4 +1,41 @@
 /**
+ * The `HashSet` module provides an immutable set data structure for storing
+ * unique values with efficient membership checks, additions, removals, and set
+ * operations. A `HashSet<A>` contains at most one value for each equality class
+ * as determined by Effect's `Equal` / `Hash` semantics.
+ *
+ * **Mental model**
+ *
+ * - `HashSet<A>` is an immutable collection of unique values of type `A`
+ * - Operations such as {@link add}, {@link remove}, {@link union}, and
+ *   {@link difference} return new sets; the input set is never mutated
+ * - Membership is checked with {@link has}, using Effect equality and hashing
+ *   rather than array-style linear scanning
+ * - Duplicate values are collapsed when using {@link make}, {@link fromIterable},
+ *   {@link add}, or {@link map}
+ * - `HashSet` is iterable, but iteration order is not a sorting guarantee
+ *
+ * **Common tasks**
+ *
+ * - Create sets: {@link empty}, {@link make}, {@link fromIterable}
+ * - Check membership and size: {@link has}, {@link size}, {@link isEmpty}
+ * - Add or remove values: {@link add}, {@link remove}
+ * - Combine sets: {@link union}, {@link intersection}, {@link difference}
+ * - Compare sets: {@link isSubset}
+ * - Transform or select values: {@link map}, {@link filter}
+ * - Test values: {@link some}, {@link every}
+ * - Fold values: {@link reduce}
+ *
+ * **Gotchas**
+ *
+ * - Values that should compare structurally should implement compatible
+ *   `Equal` and `Hash` behavior; otherwise object identity may affect whether
+ *   values are considered distinct
+ * - {@link map} may reduce the set size when multiple input values map to the
+ *   same output value
+ * - Do not rely on iteration order for deterministic presentation; sort the
+ *   values after converting to an array when order matters
+ *
  * @since 2.0.0
  */
 import type { Equal } from "./Equal.ts";
@@ -11,9 +48,10 @@ declare const TypeId = "~effect/collections/HashSet";
  * A HashSet is an immutable set data structure that provides efficient storage
  * and retrieval of unique values. It uses a HashMap internally for optimal performance.
  *
- * @example
+ * **Example** (Creating and updating a HashSet)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * // Create a HashSet
  * const set = HashSet.make("apple", "banana", "cherry")
@@ -31,8 +69,8 @@ declare const TypeId = "~effect/collections/HashSet";
  * console.log(HashSet.size(smaller)) // 2
  * ```
  *
- * @since 2.0.0
  * @category models
+ * @since 2.0.0
  */
 export interface HashSet<out Value> extends Iterable<Value>, Equal, Pipeable, Inspectable {
     readonly [TypeId]: typeof TypeId;
@@ -41,9 +79,10 @@ export interface HashSet<out Value> extends Iterable<Value>, Equal, Pipeable, In
  * The HashSet namespace contains type-level utilities and helper types
  * for working with HashSet instances.
  *
- * @example
+ * **Example** (Extracting value types from a HashSet)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * // Create a concrete HashSet for type extraction
  * const fruits = HashSet.make("apple", "banana", "cherry")
@@ -58,13 +97,17 @@ export interface HashSet<out Value> extends Iterable<Value>, Equal, Pipeable, In
  * ```
  *
  * @since 2.0.0
- * @category namespace
  */
 export declare namespace HashSet {
     /**
-     * @example
+     * Extracts the element type from a `HashSet`.
+     *
+     * For `HashSet.HashSet<A>`, `HashSet.Value<...>` resolves to `A`.
+     *
+     * **Example** (Extracting a HashSet value type)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(1, 2, 3, 4, 5)
      *
@@ -74,17 +117,18 @@ export declare namespace HashSet {
      * const processNumber = (n: NumberType) => n * 2
      * ```
      *
-     * @since 2.0.0
      * @category type-level
+     * @since 4.0.0
      */
     type Value<T> = T extends HashSet<infer V> ? V : never;
 }
 /**
  * Creates an empty HashSet.
  *
- * @example
+ * **Example** (Creating an empty HashSet)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set = HashSet.empty<string>()
  *
@@ -96,16 +140,17 @@ export declare namespace HashSet {
  * console.log(HashSet.size(withValues)) // 2
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const empty: <V = never>() => HashSet<V>;
 /**
  * Creates a HashSet from a variable number of values.
  *
- * @example
+ * **Example** (Creating a HashSet from values)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const fruits = HashSet.make("apple", "banana", "cherry")
  * console.log(HashSet.size(fruits)) // 3
@@ -117,16 +162,17 @@ export declare const empty: <V = never>() => HashSet<V>;
  * console.log(HashSet.size(mixed)) // 3
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const make: <Values extends ReadonlyArray<any>>(...values: Values) => HashSet<Values[number]>;
 /**
  * Creates a HashSet from an iterable collection of values.
  *
- * @example
+ * **Example** (Creating a HashSet from an iterable)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const fromArray = HashSet.fromIterable(["a", "b", "c", "b", "a"])
  * console.log(HashSet.size(fromArray)) // 3
@@ -138,16 +184,17 @@ export declare const make: <Values extends ReadonlyArray<any>>(...values: Values
  * console.log(Array.from(fromString)) // ["h", "e", "l", "o"]
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const fromIterable: <V>(values: Iterable<V>) => HashSet<V>;
 /**
  * Checks if a value is a HashSet.
  *
- * @example
+ * **Example** (Checking for a HashSet)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set = HashSet.make(1, 2, 3)
  * const array = [1, 2, 3]
@@ -157,16 +204,17 @@ export declare const fromIterable: <V>(values: Iterable<V>) => HashSet<V>;
  * console.log(HashSet.isHashSet(null)) // false
  * ```
  *
- * @since 2.0.0
  * @category guards
+ * @since 2.0.0
  */
 export declare const isHashSet: {
     /**
      * Checks if a value is a HashSet.
      *
-     * @example
+     * **Example** (Checking for a HashSet)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const set = HashSet.make(1, 2, 3)
      * const array = [1, 2, 3]
@@ -176,16 +224,17 @@ export declare const isHashSet: {
      * console.log(HashSet.isHashSet(null)) // false
      * ```
      *
-     * @since 2.0.0
      * @category guards
+     * @since 2.0.0
      */
     <V>(u: Iterable<V>): u is HashSet<V>;
     /**
      * Checks if a value is a HashSet.
      *
-     * @example
+     * **Example** (Checking for a HashSet)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const set = HashSet.make(1, 2, 3)
      * const array = [1, 2, 3]
@@ -195,17 +244,18 @@ export declare const isHashSet: {
      * console.log(HashSet.isHashSet(null)) // false
      * ```
      *
-     * @since 2.0.0
      * @category guards
+     * @since 2.0.0
      */
     (u: unknown): u is HashSet<unknown>;
 };
 /**
  * Adds a value to the HashSet, returning a new HashSet.
  *
- * @example
+ * **Example** (Adding values to a HashSet)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set = HashSet.make("a", "b")
  * const withC = HashSet.add(set, "c")
@@ -219,16 +269,17 @@ export declare const isHashSet: {
  * console.log(HashSet.size(same)) // 2
  * ```
  *
- * @since 2.0.0
  * @category mutations
+ * @since 2.0.0
  */
 export declare const add: {
     /**
      * Adds a value to the HashSet, returning a new HashSet.
      *
-     * @example
+     * **Example** (Adding values to a HashSet)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const set = HashSet.make("a", "b")
      * const withC = HashSet.add(set, "c")
@@ -242,16 +293,17 @@ export declare const add: {
      * console.log(HashSet.size(same)) // 2
      * ```
      *
-     * @since 2.0.0
      * @category mutations
+     * @since 2.0.0
      */
     <V>(value: V): (self: HashSet<V>) => HashSet<V>;
     /**
      * Adds a value to the HashSet, returning a new HashSet.
      *
-     * @example
+     * **Example** (Adding values to a HashSet)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const set = HashSet.make("a", "b")
      * const withC = HashSet.add(set, "c")
@@ -265,25 +317,25 @@ export declare const add: {
      * console.log(HashSet.size(same)) // 2
      * ```
      *
-     * @since 2.0.0
      * @category mutations
+     * @since 2.0.0
      */
     <V>(self: HashSet<V>, value: V): HashSet<V>;
 };
 /**
  * Checks if the HashSet contains the specified value.
  *
- * @example
+ * **Example** (Checking HashSet membership)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet" // false
+ * import { Equal, Hash, HashSet } from "effect"
  *
  * // Works with any type that implements Equal
- * import { Equal, Hash } from "effect"
  *
  * const set = HashSet.make("apple", "banana", "cherry")
  *
  * console.log(HashSet.has(set, "apple")) // true
- * console.log(HashSet.has(set, "grape"))
+ * console.log(HashSet.has(set, "grape")) // false
  *
  * class Person implements Equal.Equal {
  *   constructor(readonly name: string) {}
@@ -301,24 +353,24 @@ export declare const add: {
  * console.log(HashSet.has(people, new Person("Alice"))) // true
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 2.0.0
  */
 export declare const has: {
     /**
      * Checks if the HashSet contains the specified value.
      *
-     * @example
+     * **Example** (Checking HashSet membership)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet" // false
+     * import { Equal, Hash, HashSet } from "effect"
      *
      * // Works with any type that implements Equal
-     * import { Equal, Hash } from "effect"
      *
      * const set = HashSet.make("apple", "banana", "cherry")
      *
      * console.log(HashSet.has(set, "apple")) // true
-     * console.log(HashSet.has(set, "grape"))
+     * console.log(HashSet.has(set, "grape")) // false
      *
      * class Person implements Equal.Equal {
      *   constructor(readonly name: string) {}
@@ -336,24 +388,24 @@ export declare const has: {
      * console.log(HashSet.has(people, new Person("Alice"))) // true
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <V>(value: V): (self: HashSet<V>) => boolean;
     /**
      * Checks if the HashSet contains the specified value.
      *
-     * @example
+     * **Example** (Checking HashSet membership)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet" // false
+     * import { Equal, Hash, HashSet } from "effect"
      *
      * // Works with any type that implements Equal
-     * import { Equal, Hash } from "effect"
      *
      * const set = HashSet.make("apple", "banana", "cherry")
      *
      * console.log(HashSet.has(set, "apple")) // true
-     * console.log(HashSet.has(set, "grape"))
+     * console.log(HashSet.has(set, "grape")) // false
      *
      * class Person implements Equal.Equal {
      *   constructor(readonly name: string) {}
@@ -371,17 +423,18 @@ export declare const has: {
      * console.log(HashSet.has(people, new Person("Alice"))) // true
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <V>(self: HashSet<V>, value: V): boolean;
 };
 /**
  * Removes a value from the HashSet, returning a new HashSet.
  *
- * @example
+ * **Example** (Removing values from a HashSet)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set = HashSet.make("a", "b", "c")
  * const withoutB = HashSet.remove(set, "b")
@@ -395,16 +448,17 @@ export declare const has: {
  * console.log(HashSet.size(same)) // 3
  * ```
  *
- * @since 2.0.0
  * @category mutations
+ * @since 2.0.0
  */
 export declare const remove: {
     /**
      * Removes a value from the HashSet, returning a new HashSet.
      *
-     * @example
+     * **Example** (Removing values from a HashSet)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const set = HashSet.make("a", "b", "c")
      * const withoutB = HashSet.remove(set, "b")
@@ -418,16 +472,17 @@ export declare const remove: {
      * console.log(HashSet.size(same)) // 3
      * ```
      *
-     * @since 2.0.0
      * @category mutations
+     * @since 2.0.0
      */
     <V>(value: V): (self: HashSet<V>) => HashSet<V>;
     /**
      * Removes a value from the HashSet, returning a new HashSet.
      *
-     * @example
+     * **Example** (Removing values from a HashSet)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const set = HashSet.make("a", "b", "c")
      * const withoutB = HashSet.remove(set, "b")
@@ -441,17 +496,18 @@ export declare const remove: {
      * console.log(HashSet.size(same)) // 3
      * ```
      *
-     * @since 2.0.0
      * @category mutations
+     * @since 2.0.0
      */
     <V>(self: HashSet<V>, value: V): HashSet<V>;
 };
 /**
  * Returns the number of values in the HashSet.
  *
- * @example
+ * **Example** (Getting the HashSet size)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const empty = HashSet.empty<string>()
  * console.log(HashSet.size(empty)) // 0
@@ -463,16 +519,17 @@ export declare const remove: {
  * console.log(HashSet.size(withDuplicates)) // 3
  * ```
  *
- * @since 2.0.0
  * @category getters
+ * @since 2.0.0
  */
 export declare const size: <V>(self: HashSet<V>) => number;
 /**
  * Checks if the HashSet is empty.
  *
- * @example
+ * **Example** (Checking whether a HashSet is empty)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const empty = HashSet.empty<string>()
  * console.log(HashSet.isEmpty(empty)) // true
@@ -481,16 +538,17 @@ export declare const size: <V>(self: HashSet<V>) => number;
  * console.log(HashSet.isEmpty(nonEmpty)) // false
  * ```
  *
- * @since 2.0.0
  * @category getters
+ * @since 4.0.0
  */
 export declare const isEmpty: <V>(self: HashSet<V>) => boolean;
 /**
  * Creates the union of two HashSets.
  *
- * @example
+ * **Example** (Combining HashSets)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set1 = HashSet.make("a", "b")
  * const set2 = HashSet.make("b", "c")
@@ -500,16 +558,17 @@ export declare const isEmpty: <V>(self: HashSet<V>) => boolean;
  * console.log(HashSet.size(combined)) // 3
  * ```
  *
- * @since 2.0.0
  * @category combinators
+ * @since 2.0.0
  */
 export declare const union: {
     /**
      * Creates the union of two HashSets.
      *
-     * @example
+     * **Example** (Combining HashSets)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const set1 = HashSet.make("a", "b")
      * const set2 = HashSet.make("b", "c")
@@ -519,16 +578,17 @@ export declare const union: {
      * console.log(HashSet.size(combined)) // 3
      * ```
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <V1>(that: HashSet<V1>): <V0>(self: HashSet<V0>) => HashSet<V1 | V0>;
     /**
      * Creates the union of two HashSets.
      *
-     * @example
+     * **Example** (Combining HashSets)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const set1 = HashSet.make("a", "b")
      * const set2 = HashSet.make("b", "c")
@@ -538,17 +598,18 @@ export declare const union: {
      * console.log(HashSet.size(combined)) // 3
      * ```
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <V0, V1>(self: HashSet<V0>, that: HashSet<V1>): HashSet<V0 | V1>;
 };
 /**
  * Creates the intersection of two HashSets.
  *
- * @example
+ * **Example** (Finding common HashSet values)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set1 = HashSet.make("a", "b", "c")
  * const set2 = HashSet.make("b", "c", "d")
@@ -558,16 +619,17 @@ export declare const union: {
  * console.log(HashSet.size(common)) // 2
  * ```
  *
- * @since 2.0.0
  * @category combinators
+ * @since 2.0.0
  */
 export declare const intersection: {
     /**
      * Creates the intersection of two HashSets.
      *
-     * @example
+     * **Example** (Finding common HashSet values)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const set1 = HashSet.make("a", "b", "c")
      * const set2 = HashSet.make("b", "c", "d")
@@ -577,16 +639,17 @@ export declare const intersection: {
      * console.log(HashSet.size(common)) // 2
      * ```
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <V1>(that: HashSet<V1>): <V0>(self: HashSet<V0>) => HashSet<V1 & V0>;
     /**
      * Creates the intersection of two HashSets.
      *
-     * @example
+     * **Example** (Finding common HashSet values)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const set1 = HashSet.make("a", "b", "c")
      * const set2 = HashSet.make("b", "c", "d")
@@ -596,17 +659,18 @@ export declare const intersection: {
      * console.log(HashSet.size(common)) // 2
      * ```
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <V0, V1>(self: HashSet<V0>, that: HashSet<V1>): HashSet<V0 & V1>;
 };
 /**
  * Creates the difference of two HashSets (elements in the first set that are not in the second).
  *
- * @example
+ * **Example** (Finding HashSet differences)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const set1 = HashSet.make("a", "b", "c")
  * const set2 = HashSet.make("b", "d")
@@ -616,16 +680,17 @@ export declare const intersection: {
  * console.log(HashSet.size(diff)) // 2
  * ```
  *
- * @since 2.0.0
  * @category combinators
+ * @since 2.0.0
  */
 export declare const difference: {
     /**
      * Creates the difference of two HashSets (elements in the first set that are not in the second).
      *
-     * @example
+     * **Example** (Finding HashSet differences)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const set1 = HashSet.make("a", "b", "c")
      * const set2 = HashSet.make("b", "d")
@@ -635,16 +700,17 @@ export declare const difference: {
      * console.log(HashSet.size(diff)) // 2
      * ```
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <V1>(that: HashSet<V1>): <V0>(self: HashSet<V0>) => HashSet<V0>;
     /**
      * Creates the difference of two HashSets (elements in the first set that are not in the second).
      *
-     * @example
+     * **Example** (Finding HashSet differences)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const set1 = HashSet.make("a", "b", "c")
      * const set2 = HashSet.make("b", "d")
@@ -654,17 +720,18 @@ export declare const difference: {
      * console.log(HashSet.size(diff)) // 2
      * ```
      *
-     * @since 2.0.0
      * @category combinators
+     * @since 2.0.0
      */
     <V0, V1>(self: HashSet<V0>, that: HashSet<V1>): HashSet<V0>;
 };
 /**
  * Checks if a HashSet is a subset of another HashSet.
  *
- * @example
+ * **Example** (Checking subset relationships)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const small = HashSet.make("a", "b")
  * const large = HashSet.make("a", "b", "c", "d")
@@ -676,16 +743,17 @@ export declare const difference: {
  * console.log(HashSet.isSubset(small, small)) // true
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 2.0.0
  */
 export declare const isSubset: {
     /**
      * Checks if a HashSet is a subset of another HashSet.
      *
-     * @example
+     * **Example** (Checking subset relationships)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const small = HashSet.make("a", "b")
      * const large = HashSet.make("a", "b", "c", "d")
@@ -697,16 +765,17 @@ export declare const isSubset: {
      * console.log(HashSet.isSubset(small, small)) // true
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <V1>(that: HashSet<V1>): <V0>(self: HashSet<V0>) => boolean;
     /**
      * Checks if a HashSet is a subset of another HashSet.
      *
-     * @example
+     * **Example** (Checking subset relationships)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const small = HashSet.make("a", "b")
      * const large = HashSet.make("a", "b", "c", "d")
@@ -718,17 +787,18 @@ export declare const isSubset: {
      * console.log(HashSet.isSubset(small, small)) // true
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <V0, V1>(self: HashSet<V0>, that: HashSet<V1>): boolean;
 };
 /**
  * Maps each value in the HashSet using the provided function.
  *
- * @example
+ * **Example** (Mapping HashSet values)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const numbers = HashSet.make(1, 2, 3)
  * const doubled = HashSet.map(numbers, (n) => n * 2)
@@ -742,16 +812,17 @@ export declare const isSubset: {
  * console.log(Array.from(lengths).sort()) // [5, 6] (apple=5, banana=6, cherry=6)
  * ```
  *
- * @since 2.0.0
  * @category mapping
+ * @since 2.0.0
  */
 export declare const map: {
     /**
      * Maps each value in the HashSet using the provided function.
      *
-     * @example
+     * **Example** (Mapping HashSet values)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(1, 2, 3)
      * const doubled = HashSet.map(numbers, (n) => n * 2)
@@ -765,16 +836,17 @@ export declare const map: {
      * console.log(Array.from(lengths).sort()) // [5, 6] (apple=5, banana=6, cherry=6)
      * ```
      *
-     * @since 2.0.0
      * @category mapping
+     * @since 2.0.0
      */
     <V, U>(f: (value: V) => U): (self: HashSet<V>) => HashSet<U>;
     /**
      * Maps each value in the HashSet using the provided function.
      *
-     * @example
+     * **Example** (Mapping HashSet values)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(1, 2, 3)
      * const doubled = HashSet.map(numbers, (n) => n * 2)
@@ -788,17 +860,18 @@ export declare const map: {
      * console.log(Array.from(lengths).sort()) // [5, 6] (apple=5, banana=6, cherry=6)
      * ```
      *
-     * @since 2.0.0
      * @category mapping
+     * @since 2.0.0
      */
     <V, U>(self: HashSet<V>, f: (value: V) => U): HashSet<U>;
 };
 /**
  * Filters the HashSet keeping only values that satisfy the predicate.
  *
- * @example
+ * **Example** (Filtering HashSet values)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const numbers = HashSet.make(1, 2, 3, 4, 5, 6)
  * const evens = HashSet.filter(numbers, (n) => n % 2 === 0)
@@ -807,16 +880,17 @@ export declare const map: {
  * console.log(HashSet.size(evens)) // 3
  * ```
  *
- * @since 2.0.0
  * @category filtering
+ * @since 2.0.0
  */
 export declare const filter: {
     /**
      * Filters the HashSet keeping only values that satisfy the predicate.
      *
-     * @example
+     * **Example** (Filtering HashSet values)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(1, 2, 3, 4, 5, 6)
      * const evens = HashSet.filter(numbers, (n) => n % 2 === 0)
@@ -825,16 +899,17 @@ export declare const filter: {
      * console.log(HashSet.size(evens)) // 3
      * ```
      *
-     * @since 2.0.0
      * @category filtering
+     * @since 2.0.0
      */
     <V, U extends V>(refinement: Refinement<NoInfer<V>, U>): (self: HashSet<V>) => HashSet<U>;
     /**
      * Filters the HashSet keeping only values that satisfy the predicate.
      *
-     * @example
+     * **Example** (Filtering HashSet values)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(1, 2, 3, 4, 5, 6)
      * const evens = HashSet.filter(numbers, (n) => n % 2 === 0)
@@ -843,16 +918,17 @@ export declare const filter: {
      * console.log(HashSet.size(evens)) // 3
      * ```
      *
-     * @since 2.0.0
      * @category filtering
+     * @since 2.0.0
      */
     <V>(predicate: Predicate<NoInfer<V>>): (self: HashSet<V>) => HashSet<V>;
     /**
      * Filters the HashSet keeping only values that satisfy the predicate.
      *
-     * @example
+     * **Example** (Filtering HashSet values)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(1, 2, 3, 4, 5, 6)
      * const evens = HashSet.filter(numbers, (n) => n % 2 === 0)
@@ -861,16 +937,17 @@ export declare const filter: {
      * console.log(HashSet.size(evens)) // 3
      * ```
      *
-     * @since 2.0.0
      * @category filtering
+     * @since 2.0.0
      */
     <V, U extends V>(self: HashSet<V>, refinement: Refinement<V, U>): HashSet<U>;
     /**
      * Filters the HashSet keeping only values that satisfy the predicate.
      *
-     * @example
+     * **Example** (Filtering HashSet values)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(1, 2, 3, 4, 5, 6)
      * const evens = HashSet.filter(numbers, (n) => n % 2 === 0)
@@ -879,17 +956,18 @@ export declare const filter: {
      * console.log(HashSet.size(evens)) // 3
      * ```
      *
-     * @since 2.0.0
      * @category filtering
+     * @since 2.0.0
      */
     <V>(self: HashSet<V>, predicate: Predicate<V>): HashSet<V>;
 };
 /**
  * Tests whether at least one value in the HashSet satisfies the predicate.
  *
- * @example
+ * **Example** (Testing whether some values match)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const numbers = HashSet.make(1, 2, 3, 4, 5)
  *
@@ -900,16 +978,17 @@ export declare const filter: {
  * console.log(HashSet.some(empty, (n) => n > 0)) // false
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 2.0.0
  */
 export declare const some: {
     /**
      * Tests whether at least one value in the HashSet satisfies the predicate.
      *
-     * @example
+     * **Example** (Testing whether some values match)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(1, 2, 3, 4, 5)
      *
@@ -920,16 +999,17 @@ export declare const some: {
      * console.log(HashSet.some(empty, (n) => n > 0)) // false
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <V>(predicate: Predicate<V>): (self: HashSet<V>) => boolean;
     /**
      * Tests whether at least one value in the HashSet satisfies the predicate.
      *
-     * @example
+     * **Example** (Testing whether some values match)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(1, 2, 3, 4, 5)
      *
@@ -940,17 +1020,18 @@ export declare const some: {
      * console.log(HashSet.some(empty, (n) => n > 0)) // false
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <V>(self: HashSet<V>, predicate: Predicate<V>): boolean;
 };
 /**
  * Tests whether all values in the HashSet satisfy the predicate.
  *
- * @example
+ * **Example** (Testing whether every value matches)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const numbers = HashSet.make(2, 4, 6, 8)
  *
@@ -961,16 +1042,17 @@ export declare const some: {
  * console.log(HashSet.every(empty, (n) => n > 0)) // true (vacuously true)
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 2.0.0
  */
 export declare const every: {
     /**
      * Tests whether all values in the HashSet satisfy the predicate.
      *
-     * @example
+     * **Example** (Testing whether every value matches)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(2, 4, 6, 8)
      *
@@ -981,16 +1063,17 @@ export declare const every: {
      * console.log(HashSet.every(empty, (n) => n > 0)) // true (vacuously true)
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <V>(predicate: Predicate<V>): (self: HashSet<V>) => boolean;
     /**
      * Tests whether all values in the HashSet satisfy the predicate.
      *
-     * @example
+     * **Example** (Testing whether every value matches)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(2, 4, 6, 8)
      *
@@ -1001,17 +1084,18 @@ export declare const every: {
      * console.log(HashSet.every(empty, (n) => n > 0)) // true (vacuously true)
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <V>(self: HashSet<V>, predicate: Predicate<V>): boolean;
 };
 /**
  * Reduces the HashSet to a single value by iterating through the values and applying an accumulator function.
  *
- * @example
+ * **Example** (Reducing HashSet values)
+ *
  * ```ts
- * import * as HashSet from "effect/HashSet"
+ * import { HashSet } from "effect"
  *
  * const numbers = HashSet.make(1, 2, 3, 4, 5)
  * const sum = HashSet.reduce(numbers, 0, (acc, n) => acc + n)
@@ -1023,16 +1107,17 @@ export declare const every: {
  * console.log(concatenated) // Order may vary: "abc", "bac", etc.
  * ```
  *
- * @since 2.0.0
  * @category folding
+ * @since 2.0.0
  */
 export declare const reduce: {
     /**
      * Reduces the HashSet to a single value by iterating through the values and applying an accumulator function.
      *
-     * @example
+     * **Example** (Reducing HashSet values)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(1, 2, 3, 4, 5)
      * const sum = HashSet.reduce(numbers, 0, (acc, n) => acc + n)
@@ -1044,16 +1129,17 @@ export declare const reduce: {
      * console.log(concatenated) // Order may vary: "abc", "bac", etc.
      * ```
      *
-     * @since 2.0.0
      * @category folding
+     * @since 2.0.0
      */
     <V, U>(zero: U, f: (accumulator: U, value: V) => U): (self: HashSet<V>) => U;
     /**
      * Reduces the HashSet to a single value by iterating through the values and applying an accumulator function.
      *
-     * @example
+     * **Example** (Reducing HashSet values)
+     *
      * ```ts
-     * import * as HashSet from "effect/HashSet"
+     * import { HashSet } from "effect"
      *
      * const numbers = HashSet.make(1, 2, 3, 4, 5)
      * const sum = HashSet.reduce(numbers, 0, (acc, n) => acc + n)
@@ -1065,8 +1151,8 @@ export declare const reduce: {
      * console.log(concatenated) // Order may vary: "abc", "bac", etc.
      * ```
      *
-     * @since 2.0.0
      * @category folding
+     * @since 2.0.0
      */
     <V, U>(self: HashSet<V>, zero: U, f: (accumulator: U, value: V) => U): U;
 };