effect 4.0.0-beta.65 → 4.0.0-beta.67

package/dist/HashMap.d.ts

@@ -1,4 +1,77 @@
 /**
+ * The `HashMap` module provides an immutable key-value data structure with
+ * efficient lookup, insertion, removal, and transformation operations. A
+ * `HashMap<Key, Value>` stores entries by hashing keys and resolving matches
+ * with Effect's structural equality semantics.
+ *
+ * **Mental model**
+ *
+ * - A `HashMap<Key, Value>` is an immutable collection of key-value pairs
+ * - Operations such as {@link set}, {@link remove}, and {@link modifyAt} return
+ *   new maps; existing maps are not mutated
+ * - Keys are compared using the `Equal` protocol and are grouped by hashes from
+ *   the `Hash` protocol
+ * - Plain JavaScript primitives work as keys, and custom objects can define
+ *   `Equal` / `Hash` behavior for structural lookup
+ * - Lookups with {@link get} return an `Option`, making missing keys explicit
+ * - Iteration order is based on the map's internal hash structure and should
+ *   not be treated as insertion order
+ *
+ * **Common tasks**
+ *
+ * - Create maps: {@link empty}, {@link make}, {@link fromIterable}
+ * - Read values: {@link get}, {@link getUnsafe}, {@link has}, {@link hasBy}
+ * - Add or update entries: {@link set}, {@link modify}, {@link modifyAt}, {@link setMany}
+ * - Remove entries: {@link remove}, {@link removeMany}
+ * - Combine maps: {@link union}
+ * - Iterate or convert: {@link keys}, {@link values}, {@link entries}, {@link toValues}, {@link toEntries}
+ * - Transform values: {@link map}, {@link flatMap}, {@link filter}, {@link filterMap}, {@link compact}
+ * - Fold and search: {@link reduce}, {@link findFirst}, {@link some}, {@link every}
+ * - Batch updates efficiently: {@link mutate}, {@link beginMutation}, {@link endMutation}
+ *
+ * **Gotchas**
+ *
+ * - {@link getUnsafe} throws when the key is absent; prefer {@link get} unless
+ *   absence is impossible by construction
+ * - Mutating a key object after insertion can make future lookups fail if its
+ *   equality or hash changes
+ * - Hash collisions are handled by equality checks, so matching hashes alone do
+ *   not make two keys equal
+ * - Use {@link getHash} and {@link hasHash} only when you already have the
+ *   correct hash for the same key
+ * - Convert entries to an array and sort them when deterministic presentation is
+ *   required
+ *
+ * **Quickstart**
+ *
+ * **Example** (Working with immutable maps)
+ *
+ * ```ts
+ * import { HashMap, Option } from "effect"
+ *
+ * const scores = HashMap.make(["alice", 10], ["bob", 15])
+ *
+ * const updated = scores.pipe(
+ *   HashMap.set("carol", 20),
+ *   HashMap.modify("alice", (score) => score + 1)
+ * )
+ *
+ * console.log(HashMap.get(updated, "alice"))
+ * // Output: Option.some(11)
+ *
+ * console.log(HashMap.get(scores, "carol"))
+ * // Output: Option.none()
+ *
+ * console.log(Option.getOrElse(HashMap.get(updated, "dave"), () => 0))
+ * // Output: 0
+ * ```
+ *
+ * **See also**
+ *
+ * - {@link HashSet} for immutable sets backed by hash semantics
+ * - {@link Equal} for structural equality
+ * - {@link Hash} for hash implementations used by hashed collections
+ *
  * @since 2.0.0
  */
 import type { Equal } from "./Equal.ts";
@@ -13,7 +86,8 @@ declare const TypeId = "~effect/collections/HashMap";
  * insertion, and deletion operations. It uses a Hash Array Mapped Trie (HAMT) internally
  * for structural sharing and optimal performance.
  *
- * @example
+ * **Example** (Using basic HashMap operations)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -32,8 +106,8 @@ declare const TypeId = "~effect/collections/HashMap";
  * console.log(HashMap.size(updated)) // 4
  * ```
  *
- * @since 2.0.0
  * @category models
+ * @since 2.0.0
  */
 export interface HashMap<out Key, out Value> extends Iterable<[Key, Value]>, Equal, Pipeable, Inspectable {
     readonly [TypeId]: typeof TypeId;
@@ -42,7 +116,8 @@ export interface HashMap<out Key, out Value> extends Iterable<[Key, Value]>, Equ
  * The HashMap namespace contains type-level utilities and helper types
  * for working with HashMap instances.
  *
- * @example
+ * **Example** (Extracting HashMap types)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -69,8 +144,8 @@ export interface HashMap<out Key, out Value> extends Iterable<[Key, Value]>, Equ
  * const updatedInventory = updateInventory("tablet", newProduct)
  * ```
  *
- * @since 2.0.0
  * @category models
+ * @since 2.0.0
  */
 export declare namespace HashMap {
     /**
@@ -78,7 +153,8 @@ export declare namespace HashMap {
      * Takes an Option representing the current value and returns an Option
      * representing the new value.
      *
-     * @example
+     * **Example** (Updating values from Options)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      * import * as Option from "effect/Option"
@@ -93,14 +169,15 @@ export declare namespace HashMap {
      * console.log(HashMap.get(updated, "a")) // Option.some(2)
      * ```
      *
-     * @since 2.0.0
      * @category models
+     * @since 2.0.0
      */
     type UpdateFn<V> = (option: Option<V>) => Option<V>;
     /**
      * This type-level utility extracts the key type `K` from a `HashMap<K, V>` type.
      *
-     * @example
+     * **Example** (Extracting key types)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -117,14 +194,15 @@ export declare namespace HashMap {
      * const getUserById = (id: UserKey) => HashMap.get(userMap, id)
      * console.log(getUserById("alice")) // Option.some({ name: "Alice", age: 30 })
      * ```
-     * @since 2.0.0
      * @category type-level
+     * @since 2.0.0
      */
     type Key<T extends HashMap<any, any>> = [T] extends [HashMap<infer _K, infer _V>] ? _K : never;
     /**
      * This type-level utility extracts the value type `V` from a `HashMap<K, V>` type.
      *
-     * @example
+     * **Example** (Extracting value types)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -145,14 +223,15 @@ export declare namespace HashMap {
      * const alice = HashMap.get(userMap, "alice")
      * // alice has type Option<User> thanks to type extraction
      * ```
-     * @since 2.0.0
      * @category type-level
+     * @since 2.0.0
      */
     type Value<T extends HashMap<any, any>> = [T] extends [HashMap<infer _K, infer _V>] ? _V : never;
     /**
      * This type-level utility extracts the entry type `[K, V]` from a `HashMap<K, V>` type.
      *
-     * @example
+     * **Example** (Extracting entry types)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -170,19 +249,20 @@ export declare namespace HashMap {
      *   return `${productId}: $${product.price} (${product.category})`
      * }
      *
-     * // Convert to entries and process
-     * const descriptions = HashMap.toEntries(catalog).map(processEntry)
-     * console.log(descriptions) // ["laptop: $999 (electronics)", "book: $29 (education)"]
+     * // Convert to entries, process, and sort for deterministic output
+     * const descriptions = HashMap.toEntries(catalog).map(processEntry).sort()
+     * console.log(descriptions) // ["book: $29 (education)", "laptop: $999 (electronics)"]
      * ```
-     * @since 3.9.0
      * @category type-level
+     * @since 3.9.0
      */
     type Entry<T extends HashMap<any, any>> = [Key<T>, Value<T>];
 }
 /**
  * Checks if a value is a HashMap.
  *
- * @example
+ * **Example** (Checking HashMap values)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -194,14 +274,15 @@ export declare namespace HashMap {
  * console.log(HashMap.isHashMap(null)) // false
  * ```
  *
- * @since 2.0.0
  * @category refinements
+ * @since 2.0.0
  */
 export declare const isHashMap: {
     /**
      * Checks if a value is a HashMap.
      *
-     * @example
+     * **Example** (Checking HashMap values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -213,14 +294,15 @@ export declare const isHashMap: {
      * console.log(HashMap.isHashMap(null)) // false
      * ```
      *
-     * @since 2.0.0
      * @category refinements
+     * @since 2.0.0
      */
     <K, V>(u: Iterable<readonly [K, V]>): u is HashMap<K, V>;
     /**
      * Checks if a value is a HashMap.
      *
-     * @example
+     * **Example** (Checking HashMap values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -232,15 +314,16 @@ export declare const isHashMap: {
      * console.log(HashMap.isHashMap(null)) // false
      * ```
      *
-     * @since 2.0.0
      * @category refinements
+     * @since 2.0.0
      */
     (u: unknown): u is HashMap<unknown, unknown>;
 };
 /**
  * Creates a new empty `HashMap`.
  *
- * @example
+ * **Example** (Creating an empty HashMap)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -249,14 +332,15 @@ export declare const isHashMap: {
  * console.log(HashMap.size(map)) // 0
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const empty: <K = never, V = never>() => HashMap<K, V>;
 /**
  * Constructs a new `HashMap` from an array of key/value pairs.
  *
- * @example
+ * **Example** (Creating a HashMap from entries)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -265,14 +349,15 @@ export declare const empty: <K = never, V = never>() => HashMap<K, V>;
  * console.log(HashMap.get(map, "b")) // Option.some(2)
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const make: <Entries extends ReadonlyArray<readonly [any, any]>>(...entries: Entries) => HashMap<Entries[number] extends readonly [infer K, any] ? K : never, Entries[number] extends readonly [any, infer V] ? V : never>;
 /**
  * Creates a new `HashMap` from an iterable collection of key/value pairs.
  *
- * @example
+ * **Example** (Creating a HashMap from an iterable)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -282,14 +367,15 @@ export declare const make: <Entries extends ReadonlyArray<readonly [any, any]>>(
  * console.log(HashMap.get(map, "a")) // Option.some(1)
  * ```
  *
- * @since 2.0.0
  * @category constructors
+ * @since 2.0.0
  */
 export declare const fromIterable: <K, V>(entries: Iterable<readonly [K, V]>) => HashMap<K, V>;
 /**
- * Checks if the `HashMap` contains any entries.
+ * Checks whether the `HashMap` contains no entries.
+ *
+ * **Example** (Checking for empty HashMaps)
  *
- * @example
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -300,15 +386,16 @@ export declare const fromIterable: <K, V>(entries: Iterable<readonly [K, V]>) =>
  * console.log(HashMap.isEmpty(nonEmptyMap)) // false
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 2.0.0
  */
 export declare const isEmpty: <K, V>(self: HashMap<K, V>) => boolean;
 /**
  * Safely lookup the value for the specified key in the `HashMap` using the
  * internal hashing function.
  *
- * @example
+ * **Example** (Looking up values)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -322,15 +409,16 @@ export declare const isEmpty: <K, V>(self: HashMap<K, V>) => boolean;
  * console.log(value) // Option.some(2)
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 2.0.0
  */
 export declare const get: {
     /**
      * Safely lookup the value for the specified key in the `HashMap` using the
      * internal hashing function.
      *
-     * @example
+     * **Example** (Looking up values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -344,15 +432,16 @@ export declare const get: {
      * console.log(value) // Option.some(2)
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <K1 extends K, K>(key: K1): <V>(self: HashMap<K, V>) => Option<V>;
     /**
      * Safely lookup the value for the specified key in the `HashMap` using the
      * internal hashing function.
      *
-     * @example
+     * **Example** (Looking up values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -366,15 +455,16 @@ export declare const get: {
      * console.log(value) // Option.some(2)
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <K1 extends K, K, V>(self: HashMap<K, V>, key: K1): Option<V>;
 };
 /**
  * Lookup the value for the specified key in the `HashMap` using a custom hash.
  *
- * @example
+ * **Example** (Looking up values with a hash)
+ *
  * ```ts
  * import { Hash } from "effect"
  * import * as HashMap from "effect/HashMap"
@@ -398,14 +488,15 @@ export declare const get: {
  * console.log(notFound) // Option.none()
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 2.0.0
  */
 export declare const getHash: {
     /**
      * Lookup the value for the specified key in the `HashMap` using a custom hash.
      *
-     * @example
+     * **Example** (Looking up values with a hash)
+     *
      * ```ts
      * import { Hash } from "effect"
      * import * as HashMap from "effect/HashMap"
@@ -429,14 +520,15 @@ export declare const getHash: {
      * console.log(notFound) // Option.none()
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <K1 extends K, K>(key: K1, hash: number): <V>(self: HashMap<K, V>) => Option<V>;
     /**
      * Lookup the value for the specified key in the `HashMap` using a custom hash.
      *
-     * @example
+     * **Example** (Looking up values with a hash)
+     *
      * ```ts
      * import { Hash } from "effect"
      * import * as HashMap from "effect/HashMap"
@@ -460,8 +552,8 @@ export declare const getHash: {
      * console.log(notFound) // Option.none()
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <K1 extends K, K, V>(self: HashMap<K, V>, key: K1, hash: number): Option<V>;
 };
@@ -472,7 +564,8 @@ export declare const getHash: {
  * ⚠️ **Warning**: This function throws an error if the key is not found.
  * Use `HashMap.get` for safe access that returns `Option`.
  *
- * @example
+ * **Example** (Unsafely looking up values)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  * import * as Option from "effect/Option"
@@ -497,8 +590,8 @@ export declare const getHash: {
  * // Error: "HashMap.getUnsafe: key not found"
  * ```
  *
- * @since 2.0.0
  * @category unsafe
+ * @since 2.0.0
  */
 export declare const getUnsafe: {
     /**
@@ -508,7 +601,8 @@ export declare const getUnsafe: {
      * ⚠️ **Warning**: This function throws an error if the key is not found.
      * Use `HashMap.get` for safe access that returns `Option`.
      *
-     * @example
+     * **Example** (Unsafely looking up values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      * import * as Option from "effect/Option"
@@ -533,8 +627,8 @@ export declare const getUnsafe: {
      * // Error: "HashMap.getUnsafe: key not found"
      * ```
      *
-     * @since 2.0.0
      * @category unsafe
+     * @since 2.0.0
      */
     <K1 extends K, K>(key: K1): <V>(self: HashMap<K, V>) => V;
     /**
@@ -544,7 +638,8 @@ export declare const getUnsafe: {
      * ⚠️ **Warning**: This function throws an error if the key is not found.
      * Use `HashMap.get` for safe access that returns `Option`.
      *
-     * @example
+     * **Example** (Unsafely looking up values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      * import * as Option from "effect/Option"
@@ -569,15 +664,16 @@ export declare const getUnsafe: {
      * // Error: "HashMap.getUnsafe: key not found"
      * ```
      *
-     * @since 2.0.0
      * @category unsafe
+     * @since 2.0.0
      */
     <K1 extends K, K, V>(self: HashMap<K, V>, key: K1): V;
 };
 /**
  * Checks if the specified key has an entry in the `HashMap`.
  *
- * @example
+ * **Example** (Checking for keys)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -591,14 +687,15 @@ export declare const getUnsafe: {
  * console.log(hasB) // true
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 2.0.0
  */
 export declare const has: {
     /**
      * Checks if the specified key has an entry in the `HashMap`.
      *
-     * @example
+     * **Example** (Checking for keys)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -612,14 +709,15 @@ export declare const has: {
      * console.log(hasB) // true
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <K1 extends K, K>(key: K1): <K, V>(self: HashMap<K, V>) => boolean;
     /**
      * Checks if the specified key has an entry in the `HashMap`.
      *
-     * @example
+     * **Example** (Checking for keys)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -633,8 +731,8 @@ export declare const has: {
      * console.log(hasB) // true
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <K1 extends K, K, V>(self: HashMap<K, V>, key: K1): boolean;
 };
@@ -642,7 +740,8 @@ export declare const has: {
  * Checks if the specified key has an entry in the `HashMap` using a custom
  * hash.
  *
- * @example
+ * **Example** (Checking keys with a hash)
+ *
  * ```ts
  * import { Hash } from "effect"
  * import * as HashMap from "effect/HashMap"
@@ -657,20 +756,24 @@ export declare const has: {
  * const exactHash = Hash.string("Admin")
  * console.log(HashMap.hasHash(userMap, "Admin", exactHash)) // true
  *
- * // Check case-insensitive by using custom hash
- * const caseInsensitiveHash = Hash.string("admin".toLowerCase())
- * console.log(HashMap.hasHash(userMap, "admin", caseInsensitiveHash)) // false (different hash)
+ * // A matching hash does not override key equality
+ * console.log(HashMap.hasHash(userMap, "admin", exactHash)) // false
+ *
+ * // A different hash also cannot find the existing key
+ * const lowercaseHash = Hash.string("admin")
+ * console.log(HashMap.hasHash(userMap, "Admin", lowercaseHash)) // false
  * ```
  *
- * @since 2.0.0
  * @category elements
+ * @since 2.0.0
  */
 export declare const hasHash: {
     /**
      * Checks if the specified key has an entry in the `HashMap` using a custom
      * hash.
      *
-     * @example
+     * **Example** (Checking keys with a hash)
+     *
      * ```ts
      * import { Hash } from "effect"
      * import * as HashMap from "effect/HashMap"
@@ -685,20 +788,24 @@ export declare const hasHash: {
      * const exactHash = Hash.string("Admin")
      * console.log(HashMap.hasHash(userMap, "Admin", exactHash)) // true
      *
-     * // Check case-insensitive by using custom hash
-     * const caseInsensitiveHash = Hash.string("admin".toLowerCase())
-     * console.log(HashMap.hasHash(userMap, "admin", caseInsensitiveHash)) // false (different hash)
+     * // A matching hash does not override key equality
+     * console.log(HashMap.hasHash(userMap, "admin", exactHash)) // false
+     *
+     * // A different hash also cannot find the existing key
+     * const lowercaseHash = Hash.string("admin")
+     * console.log(HashMap.hasHash(userMap, "Admin", lowercaseHash)) // false
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <K1 extends K, K>(key: K1, hash: number): <V>(self: HashMap<K, V>) => boolean;
     /**
      * Checks if the specified key has an entry in the `HashMap` using a custom
      * hash.
      *
-     * @example
+     * **Example** (Checking keys with a hash)
+     *
      * ```ts
      * import { Hash } from "effect"
      * import * as HashMap from "effect/HashMap"
@@ -713,20 +820,24 @@ export declare const hasHash: {
      * const exactHash = Hash.string("Admin")
      * console.log(HashMap.hasHash(userMap, "Admin", exactHash)) // true
      *
-     * // Check case-insensitive by using custom hash
-     * const caseInsensitiveHash = Hash.string("admin".toLowerCase())
-     * console.log(HashMap.hasHash(userMap, "admin", caseInsensitiveHash)) // false (different hash)
+     * // A matching hash does not override key equality
+     * console.log(HashMap.hasHash(userMap, "admin", exactHash)) // false
+     *
+     * // A different hash also cannot find the existing key
+     * const lowercaseHash = Hash.string("admin")
+     * console.log(HashMap.hasHash(userMap, "Admin", lowercaseHash)) // false
      * ```
      *
-     * @since 2.0.0
      * @category elements
+     * @since 2.0.0
      */
     <K1 extends K, K, V>(self: HashMap<K, V>, key: K1, hash: number): boolean;
 };
 /**
  * Checks if an element matching the given predicate exists in the given `HashMap`.
  *
- * @example
+ * **Example** (Checking entries by predicate)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -735,14 +846,15 @@ export declare const hasHash: {
  * HashMap.hasBy(hm, (value) => value === "b") // -> false
  * ```
  *
- * @since 3.16.0
  * @category elements
+ * @since 3.16.0
  */
 export declare const hasBy: {
     /**
      * Checks if an element matching the given predicate exists in the given `HashMap`.
      *
-     * @example
+     * **Example** (Checking entries by predicate)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -751,14 +863,15 @@ export declare const hasBy: {
      * HashMap.hasBy(hm, (value) => value === "b") // -> false
      * ```
      *
-     * @since 3.16.0
      * @category elements
+     * @since 3.16.0
      */
     <K, V>(predicate: (value: NoInfer<V>, key: NoInfer<K>) => boolean): (self: HashMap<K, V>) => boolean;
     /**
      * Checks if an element matching the given predicate exists in the given `HashMap`.
      *
-     * @example
+     * **Example** (Checking entries by predicate)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -767,8 +880,8 @@ export declare const hasBy: {
      * HashMap.hasBy(hm, (value) => value === "b") // -> false
      * ```
      *
-     * @since 3.16.0
      * @category elements
+     * @since 3.16.0
      */
     <K, V>(self: HashMap<K, V>, predicate: (value: NoInfer<V>, key: NoInfer<K>) => boolean): boolean;
 };
@@ -776,7 +889,8 @@ export declare const hasBy: {
  * Sets the specified key to the specified value using the internal hashing
  * function.
  *
- * @example
+ * **Example** (Setting a value)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -790,15 +904,16 @@ export declare const hasBy: {
  * console.log(HashMap.size(map1)) // 1
  * ```
  *
- * @since 2.0.0
  * @category transformations
+ * @since 2.0.0
  */
 export declare const set: {
     /**
      * Sets the specified key to the specified value using the internal hashing
      * function.
      *
-     * @example
+     * **Example** (Setting a value)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -812,15 +927,16 @@ export declare const set: {
      * console.log(HashMap.size(map1)) // 1
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K, V>(key: K, value: V): (self: HashMap<K, V>) => HashMap<K, V>;
     /**
      * Sets the specified key to the specified value using the internal hashing
      * function.
      *
-     * @example
+     * **Example** (Setting a value)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -834,15 +950,16 @@ export declare const set: {
      * console.log(HashMap.size(map1)) // 1
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K, V>(self: HashMap<K, V>, key: K, value: V): HashMap<K, V>;
 };
 /**
  * Returns an `IterableIterator` of the keys within the `HashMap`.
  *
- * @example
+ * **Example** (Iterating keys)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -851,14 +968,15 @@ export declare const set: {
  * console.log(keys.sort()) // ["a", "b", "c"]
  * ```
  *
- * @since 2.0.0
  * @category getters
+ * @since 2.0.0
  */
 export declare const keys: <K, V>(self: HashMap<K, V>) => IterableIterator<K>;
 /**
  * Returns an `IterableIterator` of the values within the `HashMap`.
  *
- * @example
+ * **Example** (Iterating values)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -867,14 +985,15 @@ export declare const keys: <K, V>(self: HashMap<K, V>) => IterableIterator<K>;
  * console.log(values.sort()) // [1, 2, 3]
  * ```
  *
- * @since 2.0.0
  * @category getters
+ * @since 2.0.0
  */
 export declare const values: <K, V>(self: HashMap<K, V>) => IterableIterator<V>;
 /**
  * Returns an `Array` of the values within the `HashMap`.
  *
- * @example
+ * **Example** (Converting values to an array)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -897,14 +1016,15 @@ export declare const values: <K, V>(self: HashMap<K, V>) => IterableIterator<V>;
  * console.log(engineers.length) // 2
  * ```
  *
- * @since 3.13.0
  * @category getters
+ * @since 3.13.0
  */
 export declare const toValues: <K, V>(self: HashMap<K, V>) => Array<V>;
 /**
  * Returns an `IterableIterator` of the entries within the `HashMap`.
  *
- * @example
+ * **Example** (Iterating entries)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -915,30 +1035,28 @@ export declare const toValues: <K, V>(self: HashMap<K, V>) => Array<V>;
  *   ["cache.enabled", "true"]
  * )
  *
- * // Get entries iterator for processing
- * const entries = HashMap.entries(config)
+ * // Sort the derived array for deterministic output
+ * const settings = Array.from(HashMap.entries(config))
+ *   .sort(([left], [right]) => left.localeCompare(right))
+ *   .map(([key, value]) => `Setting ${key} = ${value}`)
  *
- * // Process each configuration entry
- * for (const [key, value] of entries) {
- *   console.log(`Setting ${key} = ${value}`)
- * }
- * // Setting database.host = localhost
- * // Setting database.port = 5432
- * // Setting cache.enabled = true
+ * console.log(settings)
+ * // ["Setting cache.enabled = true", "Setting database.host = localhost", "Setting database.port = 5432"]
  *
  * // Convert to array when you need all entries at once
  * const allEntries = Array.from(HashMap.entries(config))
  * console.log(allEntries.length) // 3
  * ```
  *
- * @since 2.0.0
  * @category getters
+ * @since 2.0.0
  */
 export declare const entries: <K, V>(self: HashMap<K, V>) => IterableIterator<[K, V]>;
 /**
  * Returns an `Array<[K, V]>` of the entries within the `HashMap`.
  *
- * @example
+ * **Example** (Converting entries to an array)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -963,14 +1081,15 @@ export declare const entries: <K, V>(self: HashMap<K, V>) => IterableIterator<[K
  * const sortedMap = HashMap.fromIterable(scoreEntries)
  * ```
  *
- * @since 2.0.0
  * @category getters
+ * @since 2.0.0
  */
 export declare const toEntries: <K, V>(self: HashMap<K, V>) => Array<[K, V]>;
 /**
  * Returns the number of entries within the `HashMap`.
  *
- * @example
+ * **Example** (Getting the size)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -981,14 +1100,18 @@ export declare const toEntries: <K, V>(self: HashMap<K, V>) => Array<[K, V]>;
  * console.log(HashMap.size(map)) // 3
  * ```
  *
- * @since 2.0.0
  * @category getters
+ * @since 2.0.0
  */
 export declare const size: <K, V>(self: HashMap<K, V>) => number;
 /**
- * Marks the `HashMap` as mutable for performance optimization during batch operations.
+ * Creates a transient mutable `HashMap` for efficient batched updates.
+ *
+ * Apply updates to the returned map, then call `endMutation` to finish the
+ * mutation window and use the result as an immutable `HashMap`.
+ *
+ * **Example** (Beginning batch mutation)
  *
- * @example
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1007,14 +1130,15 @@ export declare const size: <K, V>(self: HashMap<K, V>) => number;
  * console.log(HashMap.size(result)) // 2
  * ```
  *
- * @since 2.0.0
  * @category mutations
+ * @since 2.0.0
  */
 export declare const beginMutation: <K, V>(self: HashMap<K, V>) => HashMap<K, V>;
 /**
  * Marks the `HashMap` as immutable, completing the mutation cycle.
  *
- * @example
+ * **Example** (Ending batch mutation)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1037,14 +1161,19 @@ export declare const beginMutation: <K, V>(self: HashMap<K, V>) => HashMap<K, V>
  * console.log(HashMap.get(final, "z")) // Option.some(30)
  * ```
  *
- * @since 2.0.0
  * @category mutations
+ * @since 2.0.0
  */
 export declare const endMutation: <K, V>(self: HashMap<K, V>) => HashMap<K, V>;
 /**
- * Mutates the `HashMap` within the context of the provided function.
+ * Runs a batch of updates against a transient mutable copy of the `HashMap`
+ * and returns the finalized immutable result.
+ *
+ * The callback may call mutation-oriented helpers such as `set` and `remove`
+ * on the transient map.
+ *
+ * **Example** (Applying batched mutations)
  *
- * @example
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1056,14 +1185,19 @@ export declare const endMutation: <K, V>(self: HashMap<K, V>) => HashMap<K, V>;
  * // Returns a new HashMap with mutations applied
  * ```
  *
- * @since 2.0.0
  * @category mutations
+ * @since 2.0.0
  */
 export declare const mutate: {
     /**
-     * Mutates the `HashMap` within the context of the provided function.
+     * Runs a batch of updates against a transient mutable copy of the `HashMap`
+     * and returns the finalized immutable result.
+     *
+     * The callback may call mutation-oriented helpers such as `set` and `remove`
+     * on the transient map.
+     *
+     * **Example** (Applying batched mutations)
      *
-     * @example
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1075,14 +1209,19 @@ export declare const mutate: {
      * // Returns a new HashMap with mutations applied
      * ```
      *
-     * @since 2.0.0
      * @category mutations
+     * @since 2.0.0
      */
     <K, V>(f: (self: HashMap<K, V>) => void): (self: HashMap<K, V>) => HashMap<K, V>;
     /**
-     * Mutates the `HashMap` within the context of the provided function.
+     * Runs a batch of updates against a transient mutable copy of the `HashMap`
+     * and returns the finalized immutable result.
+     *
+     * The callback may call mutation-oriented helpers such as `set` and `remove`
+     * on the transient map.
+     *
+     * **Example** (Applying batched mutations)
      *
-     * @example
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1094,20 +1233,20 @@ export declare const mutate: {
      * // Returns a new HashMap with mutations applied
      * ```
      *
-     * @since 2.0.0
      * @category mutations
+     * @since 2.0.0
      */
     <K, V>(self: HashMap<K, V>, f: (self: HashMap<K, V>) => void): HashMap<K, V>;
 };
 /**
- * Set or remove the specified key in the `HashMap` using the specified
- * update function. The value of the specified key will be computed using the
- * provided hash.
+ * Sets or removes the specified key using an update function.
  *
- * The update function will be invoked with the current value of the key if it
- * exists, or `None` if no such value exists.
+ * The update function receives `Some(value)` when the key exists or `None`
+ * when it does not. Returning `Some(newValue)` stores the value, and returning
+ * `None` removes the key or leaves it absent.
+ *
+ * **Example** (Updating values with Options)
  *
- * @example
  * ```ts
  * import * as HashMap from "effect/HashMap"
  * import * as Option from "effect/Option"
@@ -1122,19 +1261,19 @@ export declare const mutate: {
  * console.log(HashMap.get(updated, "a")) // Option.some(2)
  * ```
  *
- * @since 2.0.0
  * @category transformations
+ * @since 2.0.0
  */
 export declare const modifyAt: {
     /**
-     * Set or remove the specified key in the `HashMap` using the specified
-     * update function. The value of the specified key will be computed using the
-     * provided hash.
+     * Sets or removes the specified key using an update function.
      *
-     * The update function will be invoked with the current value of the key if it
-     * exists, or `None` if no such value exists.
+     * The update function receives `Some(value)` when the key exists or `None`
+     * when it does not. Returning `Some(newValue)` stores the value, and returning
+     * `None` removes the key or leaves it absent.
+     *
+     * **Example** (Updating values with Options)
      *
-     * @example
      * ```ts
      * import * as HashMap from "effect/HashMap"
      * import * as Option from "effect/Option"
@@ -1149,19 +1288,19 @@ export declare const modifyAt: {
      * console.log(HashMap.get(updated, "a")) // Option.some(2)
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K, V>(key: K, f: HashMap.UpdateFn<V>): (self: HashMap<K, V>) => HashMap<K, V>;
     /**
-     * Set or remove the specified key in the `HashMap` using the specified
-     * update function. The value of the specified key will be computed using the
-     * provided hash.
+     * Sets or removes the specified key using an update function.
+     *
+     * The update function receives `Some(value)` when the key exists or `None`
+     * when it does not. Returning `Some(newValue)` stores the value, and returning
+     * `None` removes the key or leaves it absent.
      *
-     * The update function will be invoked with the current value of the key if it
-     * exists, or `None` if no such value exists.
+     * **Example** (Updating values with Options)
      *
-     * @example
      * ```ts
      * import * as HashMap from "effect/HashMap"
      * import * as Option from "effect/Option"
@@ -1176,22 +1315,21 @@ export declare const modifyAt: {
      * console.log(HashMap.get(updated, "a")) // Option.some(2)
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K, V>(self: HashMap<K, V>, key: K, f: HashMap.UpdateFn<V>): HashMap<K, V>;
 };
 /**
- * Alter the value of the specified key in the `HashMap` using the specified
- * update function. The value of the specified key will be computed using the
- * provided hash.
+ * Sets or removes the specified key using a precomputed hash and an update
+ * function.
  *
- * The update function will be invoked with the current value of the key if it
- * exists, or `None` if no such value exists.
+ * The update function receives `Some(value)` when the key exists or `None`
+ * when it does not. Returning `Some(newValue)` stores the value, and returning
+ * `None` removes the key or leaves it absent.
  *
- * This function will always either update or insert a value into the `HashMap`.
+ * **Example** (Updating values with a hash)
  *
- * @example
  * ```ts
  * import { Hash } from "effect"
  * import * as HashMap from "effect/HashMap"
@@ -1229,21 +1367,20 @@ export declare const modifyAt: {
  * console.log(HashMap.get(withClicks, "clicks")) // Option.some(1)
  * ```
  *
- * @since 2.0.0
  * @category transformations
+ * @since 2.0.0
  */
 export declare const modifyHash: {
     /**
-     * Alter the value of the specified key in the `HashMap` using the specified
-     * update function. The value of the specified key will be computed using the
-     * provided hash.
+     * Sets or removes the specified key using a precomputed hash and an update
+     * function.
      *
-     * The update function will be invoked with the current value of the key if it
-     * exists, or `None` if no such value exists.
+     * The update function receives `Some(value)` when the key exists or `None`
+     * when it does not. Returning `Some(newValue)` stores the value, and returning
+     * `None` removes the key or leaves it absent.
      *
-     * This function will always either update or insert a value into the `HashMap`.
+     * **Example** (Updating values with a hash)
      *
-     * @example
      * ```ts
      * import { Hash } from "effect"
      * import * as HashMap from "effect/HashMap"
@@ -1281,21 +1418,20 @@ export declare const modifyHash: {
      * console.log(HashMap.get(withClicks, "clicks")) // Option.some(1)
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K, V>(key: K, hash: number, f: HashMap.UpdateFn<V>): (self: HashMap<K, V>) => HashMap<K, V>;
     /**
-     * Alter the value of the specified key in the `HashMap` using the specified
-     * update function. The value of the specified key will be computed using the
-     * provided hash.
+     * Sets or removes the specified key using a precomputed hash and an update
+     * function.
      *
-     * The update function will be invoked with the current value of the key if it
-     * exists, or `None` if no such value exists.
+     * The update function receives `Some(value)` when the key exists or `None`
+     * when it does not. Returning `Some(newValue)` stores the value, and returning
+     * `None` removes the key or leaves it absent.
      *
-     * This function will always either update or insert a value into the `HashMap`.
+     * **Example** (Updating values with a hash)
      *
-     * @example
      * ```ts
      * import { Hash } from "effect"
      * import * as HashMap from "effect/HashMap"
@@ -1333,15 +1469,16 @@ export declare const modifyHash: {
      * console.log(HashMap.get(withClicks, "clicks")) // Option.some(1)
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K, V>(self: HashMap<K, V>, key: K, hash: number, f: HashMap.UpdateFn<V>): HashMap<K, V>;
 };
 /**
  * Updates the value of the specified key within the `HashMap` if it exists.
  *
- * @example
+ * **Example** (Modifying existing values)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1352,14 +1489,15 @@ export declare const modifyHash: {
  * console.log(HashMap.get(map2, "b")) // Option.some(2)
  * ```
  *
- * @since 2.0.0
  * @category transformations
+ * @since 2.0.0
  */
 export declare const modify: {
     /**
      * Updates the value of the specified key within the `HashMap` if it exists.
      *
-     * @example
+     * **Example** (Modifying existing values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1370,14 +1508,15 @@ export declare const modify: {
      * console.log(HashMap.get(map2, "b")) // Option.some(2)
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K, V>(key: K, f: (v: V) => V): (self: HashMap<K, V>) => HashMap<K, V>;
     /**
      * Updates the value of the specified key within the `HashMap` if it exists.
      *
-     * @example
+     * **Example** (Modifying existing values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1388,15 +1527,19 @@ export declare const modify: {
      * console.log(HashMap.get(map2, "b")) // Option.some(2)
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K, V>(self: HashMap<K, V>, key: K, f: (v: V) => V): HashMap<K, V>;
 };
 /**
- * Performs a union of this `HashMap` and that `HashMap`.
+ * Combines two `HashMap`s into one.
+ *
+ * Entries from `that` are inserted into `self`; when both maps contain an
+ * equal key, the value from `that` replaces the value from `self`.
+ *
+ * **Example** (Combining HashMaps)
  *
- * @example
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1408,14 +1551,18 @@ export declare const modify: {
  * console.log(HashMap.get(union, "b")) // Option.some(20) - map2 wins
  * ```
  *
- * @since 2.0.0
  * @category combining
+ * @since 2.0.0
  */
 export declare const union: {
     /**
-     * Performs a union of this `HashMap` and that `HashMap`.
+     * Combines two `HashMap`s into one.
+     *
+     * Entries from `that` are inserted into `self`; when both maps contain an
+     * equal key, the value from `that` replaces the value from `self`.
+     *
+     * **Example** (Combining HashMaps)
      *
-     * @example
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1427,14 +1574,18 @@ export declare const union: {
      * console.log(HashMap.get(union, "b")) // Option.some(20) - map2 wins
      * ```
      *
-     * @since 2.0.0
      * @category combining
+     * @since 2.0.0
      */
     <K1, V1>(that: HashMap<K1, V1>): <K0, V0>(self: HashMap<K0, V0>) => HashMap<K1 | K0, V1 | V0>;
     /**
-     * Performs a union of this `HashMap` and that `HashMap`.
+     * Combines two `HashMap`s into one.
+     *
+     * Entries from `that` are inserted into `self`; when both maps contain an
+     * equal key, the value from `that` replaces the value from `self`.
+     *
+     * **Example** (Combining HashMaps)
      *
-     * @example
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1446,8 +1597,8 @@ export declare const union: {
      * console.log(HashMap.get(union, "b")) // Option.some(20) - map2 wins
      * ```
      *
-     * @since 2.0.0
      * @category combining
+     * @since 2.0.0
      */
     <K0, V0, K1, V1>(self: HashMap<K0, V0>, that: HashMap<K1, V1>): HashMap<K0 | K1, V0 | V1>;
 };
@@ -1455,7 +1606,8 @@ export declare const union: {
  * Remove the entry for the specified key in the `HashMap` using the internal
  * hashing function.
  *
- * @example
+ * **Example** (Removing a key)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1467,15 +1619,16 @@ export declare const union: {
  * console.log(HashMap.has(map2, "a")) // true
  * ```
  *
- * @since 2.0.0
  * @category transformations
+ * @since 2.0.0
  */
 export declare const remove: {
     /**
      * Remove the entry for the specified key in the `HashMap` using the internal
      * hashing function.
      *
-     * @example
+     * **Example** (Removing a key)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1487,15 +1640,16 @@ export declare const remove: {
      * console.log(HashMap.has(map2, "a")) // true
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K>(key: K): <V>(self: HashMap<K, V>) => HashMap<K, V>;
     /**
      * Remove the entry for the specified key in the `HashMap` using the internal
      * hashing function.
      *
-     * @example
+     * **Example** (Removing a key)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1507,15 +1661,16 @@ export declare const remove: {
      * console.log(HashMap.has(map2, "a")) // true
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K, V>(self: HashMap<K, V>, key: K): HashMap<K, V>;
 };
 /**
  * Removes all entries in the `HashMap` which have the specified keys.
  *
- * @example
+ * **Example** (Removing multiple keys)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1527,14 +1682,15 @@ export declare const remove: {
  * console.log(HashMap.has(map2, "c")) // true
  * ```
  *
- * @since 2.0.0
  * @category transformations
+ * @since 2.0.0
  */
 export declare const removeMany: {
     /**
      * Removes all entries in the `HashMap` which have the specified keys.
      *
-     * @example
+     * **Example** (Removing multiple keys)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1546,14 +1702,15 @@ export declare const removeMany: {
      * console.log(HashMap.has(map2, "c")) // true
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K>(keys: Iterable<K>): <V>(self: HashMap<K, V>) => HashMap<K, V>;
     /**
      * Removes all entries in the `HashMap` which have the specified keys.
      *
-     * @example
+     * **Example** (Removing multiple keys)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1565,15 +1722,16 @@ export declare const removeMany: {
      * console.log(HashMap.has(map2, "c")) // true
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K, V>(self: HashMap<K, V>, keys: Iterable<K>): HashMap<K, V>;
 };
 /**
  * Sets multiple key-value pairs in the `HashMap`.
  *
- * @example
+ * **Example** (Setting multiple entries)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1586,14 +1744,15 @@ export declare const removeMany: {
  * console.log(HashMap.get(map2, "c")) // Option.some(3)
  * ```
  *
- * @since 2.0.0
  * @category transformations
+ * @since 2.0.0
  */
 export declare const setMany: {
     /**
      * Sets multiple key-value pairs in the `HashMap`.
      *
-     * @example
+     * **Example** (Setting multiple entries)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1606,14 +1765,15 @@ export declare const setMany: {
      * console.log(HashMap.get(map2, "c")) // Option.some(3)
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K, V>(entries: Iterable<readonly [K, V]>): (self: HashMap<K, V>) => HashMap<K, V>;
     /**
      * Sets multiple key-value pairs in the `HashMap`.
      *
-     * @example
+     * **Example** (Setting multiple entries)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1626,15 +1786,16 @@ export declare const setMany: {
      * console.log(HashMap.get(map2, "c")) // Option.some(3)
      * ```
      *
-     * @since 2.0.0
      * @category transformations
+     * @since 2.0.0
      */
     <K, V>(self: HashMap<K, V>, entries: Iterable<readonly [K, V]>): HashMap<K, V>;
 };
 /**
  * Maps over the entries of the `HashMap` using the specified function.
  *
- * @example
+ * **Example** (Mapping values)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1645,14 +1806,15 @@ export declare const setMany: {
  * console.log(HashMap.get(map2, "b")) // Option.some("b:4")
  * ```
  *
- * @since 2.0.0
  * @category mapping
+ * @since 2.0.0
  */
 export declare const map: {
     /**
      * Maps over the entries of the `HashMap` using the specified function.
      *
-     * @example
+     * **Example** (Mapping values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1663,14 +1825,15 @@ export declare const map: {
      * console.log(HashMap.get(map2, "b")) // Option.some("b:4")
      * ```
      *
-     * @since 2.0.0
      * @category mapping
+     * @since 2.0.0
      */
     <A, V, K>(f: (value: V, key: K) => A): (self: HashMap<K, V>) => HashMap<K, A>;
     /**
      * Maps over the entries of the `HashMap` using the specified function.
      *
-     * @example
+     * **Example** (Mapping values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1681,8 +1844,8 @@ export declare const map: {
      * console.log(HashMap.get(map2, "b")) // Option.some("b:4")
      * ```
      *
-     * @since 2.0.0
      * @category mapping
+     * @since 2.0.0
      */
     <K, V, A>(self: HashMap<K, V>, f: (value: V, key: K) => A): HashMap<K, A>;
 };
@@ -1691,7 +1854,8 @@ export declare const map: {
  *
  * **NOTE**: the hash and equal of both maps have to be the same.
  *
- * @example
+ * **Example** (FlatMapping values)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1706,8 +1870,8 @@ export declare const map: {
  * console.log(HashMap.get(map2, "b2")) // Option.some(4)
  * ```
  *
- * @since 2.0.0
  * @category sequencing
+ * @since 2.0.0
  */
 export declare const flatMap: {
     /**
@@ -1715,7 +1879,8 @@ export declare const flatMap: {
      *
      * **NOTE**: the hash and equal of both maps have to be the same.
      *
-     * @example
+     * **Example** (FlatMapping values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1730,8 +1895,8 @@ export declare const flatMap: {
      * console.log(HashMap.get(map2, "b2")) // Option.some(4)
      * ```
      *
-     * @since 2.0.0
      * @category sequencing
+     * @since 2.0.0
      */
     <A, K, B>(f: (value: A, key: K) => HashMap<K, B>): (self: HashMap<K, A>) => HashMap<K, B>;
     /**
@@ -1739,7 +1904,8 @@ export declare const flatMap: {
      *
      * **NOTE**: the hash and equal of both maps have to be the same.
      *
-     * @example
+     * **Example** (FlatMapping values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1754,15 +1920,16 @@ export declare const flatMap: {
      * console.log(HashMap.get(map2, "b2")) // Option.some(4)
      * ```
      *
-     * @since 2.0.0
      * @category sequencing
+     * @since 2.0.0
      */
     <K, A, B>(self: HashMap<K, A>, f: (value: A, key: K) => HashMap<K, B>): HashMap<K, B>;
 };
 /**
  * Applies the specified function to the entries of the `HashMap`.
  *
- * @example
+ * **Example** (Iterating with side effects)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1776,14 +1943,15 @@ export declare const flatMap: {
  * console.log(collected.sort()) // [["a", 1], ["b", 2]]
  * ```
  *
- * @since 2.0.0
  * @category traversing
+ * @since 2.0.0
  */
 export declare const forEach: {
     /**
      * Applies the specified function to the entries of the `HashMap`.
      *
-     * @example
+     * **Example** (Iterating with side effects)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1797,14 +1965,15 @@ export declare const forEach: {
      * console.log(collected.sort()) // [["a", 1], ["b", 2]]
      * ```
      *
-     * @since 2.0.0
      * @category traversing
+     * @since 2.0.0
      */
     <V, K>(f: (value: V, key: K) => void): (self: HashMap<K, V>) => void;
     /**
      * Applies the specified function to the entries of the `HashMap`.
      *
-     * @example
+     * **Example** (Iterating with side effects)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1818,15 +1987,16 @@ export declare const forEach: {
      * console.log(collected.sort()) // [["a", 1], ["b", 2]]
      * ```
      *
-     * @since 2.0.0
      * @category traversing
+     * @since 2.0.0
      */
     <V, K>(self: HashMap<K, V>, f: (value: V, key: K) => void): void;
 };
 /**
  * Reduces the specified state over the entries of the `HashMap`.
  *
- * @example
+ * **Example** (Reducing values)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1836,14 +2006,15 @@ export declare const forEach: {
  * console.log(sum) // 6
  * ```
  *
- * @since 2.0.0
  * @category folding
+ * @since 2.0.0
  */
 export declare const reduce: {
     /**
      * Reduces the specified state over the entries of the `HashMap`.
      *
-     * @example
+     * **Example** (Reducing values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1853,14 +2024,15 @@ export declare const reduce: {
      * console.log(sum) // 6
      * ```
      *
-     * @since 2.0.0
      * @category folding
+     * @since 2.0.0
      */
     <Z, V, K>(zero: Z, f: (accumulator: Z, value: V, key: K) => Z): (self: HashMap<K, V>) => Z;
     /**
      * Reduces the specified state over the entries of the `HashMap`.
      *
-     * @example
+     * **Example** (Reducing values)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1870,15 +2042,16 @@ export declare const reduce: {
      * console.log(sum) // 6
      * ```
      *
-     * @since 2.0.0
      * @category folding
+     * @since 2.0.0
      */
     <K, V, Z>(self: HashMap<K, V>, zero: Z, f: (accumulator: Z, value: V, key: K) => Z): Z;
 };
 /**
  * Filters entries out of a `HashMap` using the specified predicate.
  *
- * @example
+ * **Example** (Filtering entries)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -1891,14 +2064,15 @@ export declare const reduce: {
  * console.log(HashMap.has(map2, "a")) // false
  * ```
  *
- * @since 2.0.0
  * @category filtering
+ * @since 2.0.0
  */
 export declare const filter: {
     /**
      * Filters entries out of a `HashMap` using the specified predicate.
      *
-     * @example
+     * **Example** (Filtering entries)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1911,14 +2085,15 @@ export declare const filter: {
      * console.log(HashMap.has(map2, "a")) // false
      * ```
      *
-     * @since 2.0.0
      * @category filtering
+     * @since 2.0.0
      */
     <K, A>(f: (a: NoInfer<A>, k: K) => boolean): (self: HashMap<K, A>) => HashMap<K, A>;
     /**
      * Filters entries out of a `HashMap` using the specified predicate.
      *
-     * @example
+     * **Example** (Filtering entries)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -1931,15 +2106,16 @@ export declare const filter: {
      * console.log(HashMap.has(map2, "a")) // false
      * ```
      *
-     * @since 2.0.0
      * @category filtering
+     * @since 2.0.0
      */
     <K, A>(self: HashMap<K, A>, f: (a: A, k: K) => boolean): HashMap<K, A>;
 };
 /**
  * Filters out `None` values from a `HashMap` of `Options`s.
  *
- * @example
+ * **Example** (Compacting Option values)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  * import * as Option from "effect/Option"
@@ -1956,15 +2132,16 @@ export declare const filter: {
  * console.log(HashMap.has(map2, "b")) // false
  * ```
  *
- * @since 2.0.0
  * @category filtering
+ * @since 2.0.0
  */
 export declare const compact: <K, A>(self: HashMap<K, Option<A>>) => HashMap<K, A>;
 /**
  * Maps over the entries of the `HashMap` using the specified filter and keeps
  * only successful results.
  *
- * @example
+ * **Example** (Filtering and mapping Results)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  * import * as Result from "effect/Result"
@@ -1980,15 +2157,16 @@ export declare const compact: <K, A>(self: HashMap<K, Option<A>>) => HashMap<K,
  * console.log(HashMap.get(map2, "d")) // Option.some(8)
  * ```
  *
- * @since 2.0.0
  * @category filtering
+ * @since 2.0.0
  */
 export declare const filterMap: {
     /**
      * Maps over the entries of the `HashMap` using the specified filter and keeps
      * only successful results.
      *
-     * @example
+     * **Example** (Filtering and mapping Results)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      * import * as Result from "effect/Result"
@@ -2004,15 +2182,16 @@ export declare const filterMap: {
      * console.log(HashMap.get(map2, "d")) // Option.some(8)
      * ```
      *
-     * @since 2.0.0
      * @category filtering
+     * @since 2.0.0
      */
     <A, K, B, X>(f: (input: A, key: K) => Result<B, X>): (self: HashMap<K, A>) => HashMap<K, B>;
     /**
      * Maps over the entries of the `HashMap` using the specified filter and keeps
      * only successful results.
      *
-     * @example
+     * **Example** (Filtering and mapping Results)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      * import * as Result from "effect/Result"
@@ -2028,8 +2207,8 @@ export declare const filterMap: {
      * console.log(HashMap.get(map2, "d")) // Option.some(8)
      * ```
      *
-     * @since 2.0.0
      * @category filtering
+     * @since 2.0.0
      */
     <K, A, B, X>(self: HashMap<K, A>, f: (input: A, key: K) => Result<B, X>): HashMap<K, B>;
 };
@@ -2037,15 +2216,16 @@ export declare const filterMap: {
  * Returns the first element that satisfies the specified
  * predicate, or `None` if no such element exists.
  *
- * @example
+ * **Example** (Finding the first matching entry)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  * import * as Option from "effect/Option"
  *
  * const map = HashMap.make(["a", 1], ["b", 2], ["c", 3])
- * const result = HashMap.findFirst(map, (value) => value > 1)
- * console.log(result) // Option.some(["c", 3])
- * console.log(Option.getOrElse(result, () => ["", 0])) // ["c", 3]
+ * const result = HashMap.findFirst(map, (value, key) => key === "b" && value > 1)
+ * console.log(result) // Option.some(["b", 2])
+ * console.log(Option.getOrElse(result, () => ["", 0])) // ["b", 2]
  * ```
  *
  * @category elements
@@ -2056,15 +2236,16 @@ export declare const findFirst: {
      * Returns the first element that satisfies the specified
      * predicate, or `None` if no such element exists.
      *
-     * @example
+     * **Example** (Finding the first matching entry)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      * import * as Option from "effect/Option"
      *
      * const map = HashMap.make(["a", 1], ["b", 2], ["c", 3])
-     * const result = HashMap.findFirst(map, (value) => value > 1)
-     * console.log(result) // Option.some(["c", 3])
-     * console.log(Option.getOrElse(result, () => ["", 0])) // ["c", 3]
+     * const result = HashMap.findFirst(map, (value, key) => key === "b" && value > 1)
+     * console.log(result) // Option.some(["b", 2])
+     * console.log(Option.getOrElse(result, () => ["", 0])) // ["b", 2]
      * ```
      *
      * @category elements
@@ -2075,15 +2256,16 @@ export declare const findFirst: {
      * Returns the first element that satisfies the specified
      * predicate, or `None` if no such element exists.
      *
-     * @example
+     * **Example** (Finding the first matching entry)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      * import * as Option from "effect/Option"
      *
      * const map = HashMap.make(["a", 1], ["b", 2], ["c", 3])
-     * const result = HashMap.findFirst(map, (value) => value > 1)
-     * console.log(result) // Option.some(["c", 3])
-     * console.log(Option.getOrElse(result, () => ["", 0])) // ["c", 3]
+     * const result = HashMap.findFirst(map, (value, key) => key === "b" && value > 1)
+     * console.log(result) // Option.some(["b", 2])
+     * console.log(Option.getOrElse(result, () => ["", 0])) // ["b", 2]
      * ```
      *
      * @category elements
@@ -2094,7 +2276,8 @@ export declare const findFirst: {
 /**
  * Checks if any entry in a hashmap meets a specific condition.
  *
- * @example
+ * **Example** (Checking for any matching entry)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -2104,14 +2287,15 @@ export declare const findFirst: {
  * console.log(HashMap.some(map, (value) => value > 5)) // false
  * ```
  *
- * @since 3.13.0
  * @category elements
+ * @since 3.13.0
  */
 export declare const some: {
     /**
      * Checks if any entry in a hashmap meets a specific condition.
      *
-     * @example
+     * **Example** (Checking for any matching entry)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -2121,14 +2305,15 @@ export declare const some: {
      * console.log(HashMap.some(map, (value) => value > 5)) // false
      * ```
      *
-     * @since 3.13.0
      * @category elements
+     * @since 3.13.0
      */
     <K, A>(predicate: (a: NoInfer<A>, k: K) => boolean): (self: HashMap<K, A>) => boolean;
     /**
      * Checks if any entry in a hashmap meets a specific condition.
      *
-     * @example
+     * **Example** (Checking for any matching entry)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -2138,15 +2323,16 @@ export declare const some: {
      * console.log(HashMap.some(map, (value) => value > 5)) // false
      * ```
      *
-     * @since 3.13.0
      * @category elements
+     * @since 3.13.0
      */
     <K, A>(self: HashMap<K, A>, predicate: (a: A, k: K) => boolean): boolean;
 };
 /**
  * Checks if all entries in a hashmap meets a specific condition.
  *
- * @example
+ * **Example** (Checking all entries)
+ *
  * ```ts
  * import * as HashMap from "effect/HashMap"
  *
@@ -2159,14 +2345,15 @@ export declare const some: {
  * @param self - The hashmap to check.
  * @param predicate - The condition to test entries (value, key).
  *
- * @since 3.14.0
  * @category elements
+ * @since 3.14.0
  */
 export declare const every: {
     /**
      * Checks if all entries in a hashmap meets a specific condition.
      *
-     * @example
+     * **Example** (Checking all entries)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -2179,14 +2366,15 @@ export declare const every: {
      * @param self - The hashmap to check.
      * @param predicate - The condition to test entries (value, key).
      *
-     * @since 3.14.0
      * @category elements
+     * @since 3.14.0
      */
     <K, A>(predicate: (a: NoInfer<A>, k: K) => boolean): (self: HashMap<K, A>) => boolean;
     /**
      * Checks if all entries in a hashmap meets a specific condition.
      *
-     * @example
+     * **Example** (Checking all entries)
+     *
      * ```ts
      * import * as HashMap from "effect/HashMap"
      *
@@ -2199,8 +2387,8 @@ export declare const every: {
      * @param self - The hashmap to check.
      * @param predicate - The condition to test entries (value, key).
      *
-     * @since 3.14.0
      * @category elements
+     * @since 3.14.0
      */
     <K, A>(self: HashMap<K, A>, predicate: (a: A, k: K) => boolean): boolean;
 };