ts-data-forge 3.3.0 → 4.0.0

package/dist/collections/imap.d.mts

@@ -1,68 +1,111 @@
-import { Optional } from '../functional/index.mjs';
 /**
- * Interface for an immutable map with O(1) lookup performance and functional programming patterns.
+ * Interface for an immutable map with lookup operations and functional
+ * programming patterns.
  *
- * This interface defines all methods and properties available on IMap instances. All operations
- * that modify the map return new IMap instances, preserving immutability. The underlying implementation
- * uses JavaScript's native Map for O(1) average-case performance on get, set, has, and delete operations.
+ * This interface defines all methods and properties available on IMap
+ * instances. All operations that modify the map return new IMap instances,
+ * preserving immutability. The underlying implementation uses JavaScript's
+ * native Map but creates copies on mutations to maintain immutability.
  *
  * **Immutability Guarantees:**
+ *
  * - All mutation operations (set, delete, update) return new IMap instances
  * - Original IMap instances are never modified
  * - Safe for concurrent access and functional programming patterns
  *
  * **Performance Characteristics:**
- * - get/has/delete: O(1) average case
- * - set: O(1) average case
+ *
+ * - get/has: O(1) average case
+ * - set/delete: O(n) due to copying for immutability
  * - map/filter operations: O(n)
- * - Iteration: O(n)
+ * - iteration: O(n)
  *
- * @template K The type of the keys in the map. Must extend MapSetKeyType (string, number, boolean, etc.)
+ * @template K The type of the keys in the map. Must extend MapSetKeyType
+ *   (string, number, boolean, etc.)
  * @template V The type of the values in the map.
- *
- * @example
- * ```typescript
- * // This is a type alias describing an interface, so it's not directly instantiated.
- * // See IMap.create for examples of creating IMap instances that conform to this interface.
- *
- * // Example of how you might use a variable that implements this structure:
- * declare const userMap: IMap<string, User>;
- *
- * // Immutable operations - original map is never modified
- * const hasUser = userMap.has("alice");                    // O(1)
- * const user = userMap.get("alice").unwrapOr(defaultUser); // O(1)
- * const newMap = userMap.set("bob", newUser);              // O(1) - returns new IMap
- * const updated = userMap.update("alice", u => ({ ...u, active: true })); // O(1)
- *
- * // Functional transformations
- * const activeUsers = userMap.map((user, id) => ({ ...user, lastSeen: Date.now() })); // O(n)
- * ```
  */
 type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
-    /** The number of elements in the map. */
+    /**
+     * The number of elements in the map.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['a', 1],
+     *   ['b', 2],
+     * ] satisfies readonly (readonly [string, number])[];
+     *
+     * const map = IMap.create(entries);
+     *
+     * assert(map.size === 2);
+     * ```
+     */
     size: SizeType.Arr;
     /**
-     * Checks if a key exists in the map.
-     * Allows for wider literal types for keys during checking.
+     * Checks if a key exists in the map. Allows for wider literal types for keys
+     * during checking.
+     *
+     * @example
+     *
+     * ```ts
+     * const map = IMap.create<'id' | 'enabled', number | boolean>([
+     *   ['id', 42],
+     *   ['enabled', true],
+     * ]);
+     *
+     * assert.ok(map.has('id'));
+     * assert.notOk(map.has('missing'));
+     * ```
+     *
      * @param key The key to check.
      * @returns `true` if the key exists, `false` otherwise.
      */
     has: (key: K | (WidenLiteral<K> & {})) => boolean;
     /**
      * Retrieves the value associated with a key.
+     *
+     * @example
+     *
+     * ```ts
+     * const map = IMap.create([['user', { id: 1 }]]);
+     *
+     * assert.deepStrictEqual(map.get('user'), Optional.some({ id: 1 }));
+     * assert.deepStrictEqual(map.get('missing'), Optional.none);
+     * ```
+     *
      * @param key The key to retrieve.
-     * @returns The value associated with the key wrapped with Optional.some, or `Optional.none` if the key does not exist.
+     * @returns The value associated with the key wrapped with Optional.some, or
+     *   `Optional.none` if the key does not exist.
      */
     get: (key: K | (WidenLiteral<K> & {})) => Optional<V>;
     /**
      * Checks if all elements in the map satisfy a predicate.
+     *
+     * @example
+     *
+     * ```ts
+     * const map = IMap.create([
+     *   ['a', 2],
+     *   ['b', 4],
+     * ]);
+     *
+     * const allEven = map.every((value) => value % 2 === 0);
+     * const isNarrowed = map.every((value): value is 2 | 4 => value % 2 === 0);
+     *
+     * assert.ok(allEven);
+     * assert.ok(isNarrowed);
+     * ```
+     *
      * @param predicate A function to test each key-value pair.
      * @returns `true` if all elements satisfy the predicate, `false` otherwise.
      */
     every: ((predicate: (value: V, key: K) => boolean) => boolean) & 
     /**
-     * Checks if all elements in the map satisfy a type predicate.
-     * Narrows the type of values in the map if the predicate returns true for all elements.
+     * Checks if all elements in the map satisfy a type predicate. Narrows the
+     * type of values in the map if the predicate returns true for all
+     * elements.
+     *
      * @template W The narrowed type of the values.
      * @param predicate A type predicate function.
      * @returns `true` if all elements satisfy the predicate, `false` otherwise.
@@ -70,18 +113,70 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
     (<W extends V>(predicate: (value: V, key: K) => value is W) => this is IMap<K, W>);
     /**
      * Checks if at least one element in the map satisfies a predicate.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['alice', 3],
+     *   ['bob', 5],
+     * ] satisfies readonly (readonly [string, number])[];
+     *
+     * const map = IMap.create(entries);
+     *
+     * assert.ok(map.some((value) => value > 4));
+     * assert.notOk(map.some((value) => value > 10));
+     * ```
+     *
      * @param predicate A function to test each key-value pair.
-     * @returns `true` if at least one element satisfies the predicate, `false` otherwise.
+     * @returns `true` if at least one element satisfies the predicate, `false`
+     *   otherwise.
      */
     some: (predicate: (value: V, key: K) => boolean) => boolean;
     /**
      * Deletes a key-value pair from the map.
+     *
+     * @example
+     *
+     * ```ts
+     * const original = IMap.create([
+     *   ['a', 1],
+     *   ['b', 2],
+     * ]);
+     *
+     * const withoutB = original.delete('b');
+     *
+     * assert.deepStrictEqual(original.get('b'), Optional.some(2));
+     * assert.deepStrictEqual(withoutB.get('b'), Optional.none);
+     * assert(original.size === 2);
+     * assert(withoutB.size === 1);
+     * ```
+     *
      * @param key The key to delete.
      * @returns A new IMap instance without the specified key.
      */
     delete: (key: K) => IMap<K, V>;
     /**
      * Sets a key-value pair in the map.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [['count', 1]] satisfies readonly (readonly [
+     *   'count' | 'status',
+     *   number | string,
+     * ])[];
+     *
+     * const base = IMap.create<'count' | 'status', number | string>(entries);
+     *
+     * const updated = base.set('count', 2);
+     * const extended = base.set('status', 'ok');
+     *
+     * assert.deepStrictEqual(base.get('count'), Optional.some(1));
+     * assert.deepStrictEqual(updated.get('count'), Optional.some(2));
+     * assert.deepStrictEqual(extended.get('status'), Optional.some('ok'));
+     * ```
+     *
      * @param key The key to set.
      * @param value The value to associate with the key.
      * @returns A new IMap instance with the specified key-value pair.
@@ -89,13 +184,62 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
     set: (key: K, value: V) => IMap<K, V>;
     /**
      * Updates the value associated with a key using an updater function.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['alice', 10],
+     *   ['bob', 8],
+     * ] satisfies readonly (readonly ['alice' | 'bob' | 'charlie', number])[];
+     *
+     * const scores = IMap.create<'alice' | 'bob' | 'charlie', number>(entries);
+     *
+     * const boosted = scores.update('alice', (value) => value + 5);
+     * const unchanged = scores.update('charlie', (value) => value + 1);
+     *
+     * assert.deepStrictEqual(boosted.get('alice'), Optional.some(15));
+     * assert.deepStrictEqual(scores.get('alice'), Optional.some(10));
+     * assert(unchanged === scores);
+     * ```
+     *
      * @param key The key whose value to update.
-     * @param updater A function that takes the current value and returns the new value.
+     * @param updater A function that takes the current value and returns the new
+     *   value.
      * @returns A new IMap instance with the updated value.
      */
     update: (key: K, updater: (value: V) => V) => IMap<K, V>;
     /**
      * Applies a series of mutations to the map.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['a', 1],
+     *   ['b', 2],
+     * ] satisfies readonly (readonly ['a' | 'b' | 'c', number])[];
+     *
+     * const base = IMap.create<'a' | 'b' | 'c', number>(entries);
+     *
+     * const actions: readonly Readonly<
+     *   | { type: 'set'; key: 'c'; value: number }
+     *   | { type: 'update'; key: 'b'; updater: (value: number) => number }
+     *   | { type: 'delete'; key: 'a' }
+     * >[] = [
+     *   { type: 'set', key: 'c', value: 3 },
+     *   { type: 'update', key: 'b', updater: (value) => value * 10 },
+     *   { type: 'delete', key: 'a' },
+     * ];
+     *
+     * const mutated = base.withMutations(actions);
+     *
+     * assert.deepStrictEqual(mutated.get('c'), Optional.some(3));
+     * assert.deepStrictEqual(mutated.get('b'), Optional.some(20));
+     * assert.deepStrictEqual(mutated.get('a'), Optional.none);
+     * assert.deepStrictEqual(base.get('b'), Optional.some(2));
+     * ```
+     *
      * @param actions An array of mutation actions (delete, set, or update).
      * @returns A new IMap instance with all mutations applied.
      */
@@ -113,6 +257,25 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
     }>[]) => IMap<K, V>;
     /**
      * Maps the values of the map to new values.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['a', 1],
+     *   ['b', 2],
+     * ] satisfies readonly (readonly [string, number])[];
+     *
+     * const map = IMap.create(entries);
+     *
+     * const doubled = map.map((value) => value * 2);
+     *
+     * assert.deepStrictEqual(Array.from(doubled), [
+     *   ['a', 2],
+     *   ['b', 4],
+     * ]);
+     * ```
+     *
      * @template V2 The type of the new values.
      * @param mapFn A function that maps a value and key to a new value.
      * @returns A new IMap instance with mapped values.
@@ -120,6 +283,25 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
     map: <V2>(mapFn: (value: V, key: K) => V2) => IMap<K, V2>;
     /**
      * Maps the keys of the map to new keys.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['first', 1],
+     *   ['second', 2],
+     * ] satisfies readonly (readonly [string, number])[];
+     *
+     * const map = IMap.create(entries);
+     *
+     * const upperKeys = map.mapKeys((key) => key.toUpperCase());
+     *
+     * assert.deepStrictEqual(Array.from(upperKeys), [
+     *   ['FIRST', 1],
+     *   ['SECOND', 2],
+     * ]);
+     * ```
+     *
      * @template K2 The type of the new keys.
      * @param mapFn A function that maps a key to a new key.
      * @returns A new IMap instance with mapped keys and original values.
@@ -127,6 +309,27 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
     mapKeys: <K2 extends MapSetKeyType>(mapFn: (key: K) => K2) => IMap<K2, V>;
     /**
      * Maps the entries (key-value pairs) of the map to new entries.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['a', 1],
+     *   ['b', 2],
+     * ] satisfies readonly (readonly [string, number])[];
+     *
+     * const map = IMap.create(entries);
+     *
+     * const swapped = map.mapEntries(
+     *   ([key, value]) => [value, key] satisfies readonly [number, string],
+     * );
+     *
+     * assert.deepStrictEqual(Array.from(swapped), [
+     *   [1, 'a'],
+     *   [2, 'b'],
+     * ]);
+     * ```
+     *
      * @template K2 The type of the new keys in the entries.
      * @template V2 The type of the new values in the entries.
      * @param mapFn A function that maps an entry to a new entry.
@@ -135,66 +338,215 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
     mapEntries: <K2 extends MapSetKeyType, V2>(mapFn: (entry: readonly [K, V]) => readonly [K2, V2]) => IMap<K2, V2>;
     /**
      * Executes a callback function for each key-value pair in the map.
+     *
+     * @example
+     *
+     * ```ts
+     * const map = IMap.create([
+     *   ['a', 1],
+     *   ['b', 2],
+     * ]);
+     *
+     * const entries: (readonly [string, number])[] = [];
+     *
+     * for (const [key, value] of map.entries()) {
+     *   entries.push([key, value]);
+     * }
+     *
+     * assert.deepStrictEqual(entries, [
+     *   ['a', 1],
+     *   ['b', 2],
+     * ]);
+     * ```
+     *
      * @param callbackfn A function to execute for each element.
      */
     forEach: (callbackfn: (value: V, key: K) => void) => void;
     /**
      * Returns an iterator for the keys in the map.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['a', 1],
+     *   ['b', 2],
+     * ] satisfies readonly (readonly [string, number])[];
+     *
+     * const map = IMap.create(entries);
+     *
+     * const keys = Array.from(map.keys());
+     *
+     * assert.deepStrictEqual(keys, ['a', 'b']);
+     * ```
+     *
      * @returns An iterable iterator of keys.
      */
     keys: () => IterableIterator<K>;
     /**
      * Returns an iterator for the values in the map.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['a', 1],
+     *   ['b', 2],
+     * ] satisfies readonly (readonly [string, number])[];
+     *
+     * const map = IMap.create(entries);
+     *
+     * const values = Array.from(map.values());
+     *
+     * assert.deepStrictEqual(values, [1, 2]);
+     * ```
+     *
      * @returns An iterable iterator of values.
      */
     values: () => IterableIterator<V>;
     /**
      * Returns an iterator for the entries (key-value pairs) in the map.
+     *
+     * @example
+     *
+     * ```ts
+     * const map = IMap.create([
+     *   ['a', 1],
+     *   ['b', 2],
+     * ]);
+     *
+     * const entries = Array.from(map.entries());
+     *
+     * assert.deepStrictEqual(entries, [
+     *   ['a', 1],
+     *   ['b', 2],
+     * ]);
+     * ```
+     *
      * @returns An iterable iterator of entries.
      */
     entries: () => IterableIterator<readonly [K, V]>;
     /**
      * Converts the keys of the map to an array.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['x', 10],
+     *   ['y', 20],
+     * ] satisfies readonly (readonly [string, number])[];
+     *
+     * const map = IMap.create(entries);
+     *
+     * assert.deepStrictEqual(map.toKeysArray(), ['x', 'y']);
+     * ```
+     *
      * @returns A readonly array of keys.
      */
     toKeysArray: () => readonly K[];
     /**
      * Converts the values of the map to an array.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['x', 10],
+     *   ['y', 20],
+     * ] satisfies readonly (readonly [string, number])[];
+     *
+     * const map = IMap.create(entries);
+     *
+     * assert.deepStrictEqual(map.toValuesArray(), [10, 20]);
+     * ```
+     *
      * @returns A readonly array of values.
      */
     toValuesArray: () => readonly V[];
     /**
      * Converts the entries (key-value pairs) of the map to an array.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['a', 1],
+     *   ['b', 2],
+     * ] satisfies readonly (readonly [string, number])[];
+     *
+     * const map = IMap.create(entries);
+     *
+     * assert.deepStrictEqual(map.toEntriesArray(), [
+     *   ['a', 1],
+     *   ['b', 2],
+     * ]);
+     * ```
+     *
      * @returns A readonly array of entries.
      */
     toEntriesArray: () => readonly (readonly [K, V])[];
     /**
-     * Converts the map to an array of entries (key-value pairs).
-     * Alias for `toEntriesArray`.
+     * Converts the map to an array of entries (key-value pairs). Alias for
+     * `toEntriesArray`.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [
+     *   ['k1', 'v1'],
+     *   ['k2', 'v2'],
+     * ] satisfies readonly (readonly [string, string])[];
+     *
+     * const map = IMap.create(entries);
+     *
+     * assert.deepStrictEqual(map.toArray(), [
+     *   ['k1', 'v1'],
+     *   ['k2', 'v2'],
+     * ]);
+     * ```
+     *
      * @returns A readonly array of entries.
      */
     toArray: () => readonly (readonly [K, V])[];
     /**
      * Returns the underlying readonly JavaScript Map.
+     *
+     * @example
+     *
+     * ```ts
+     * const entries = [['key', 1]] satisfies readonly (readonly [string, number])[];
+     *
+     * const map = IMap.create(entries);
+     *
+     * const raw = map.toRawMap();
+     *
+     * assert.ok(is.map(raw));
+     * assert(raw.get('key') === 1);
+     * ```
+     *
      * @returns The raw ReadonlyMap instance.
      */
     toRawMap: () => ReadonlyMap<K, V>;
 }>;
 /**
- * Represents an immutable map with high-performance operations and functional programming support.
+ * Represents an immutable map with high-performance operations and functional
+ * programming support.
  *
- * IMap is a persistent data structure that provides all the functionality of JavaScript's Map
- * while maintaining immutability. All operations that would normally mutate the map instead
- * return new IMap instances, making it safe for functional programming and concurrent access.
+ * IMap is a persistent data structure that provides all the functionality of
+ * JavaScript's Map while maintaining immutability. All operations that would
+ * normally mutate the map instead return new IMap instances, making it safe for
+ * functional programming and concurrent access.
  *
  * **Key Features:**
+ *
  * - **Immutable**: All mutation operations return new instances
- * - **High Performance**: O(1) average-case for get/set/has/delete operations
  * - **Type Safe**: Full TypeScript support with generic key/value types
  * - **Iterable**: Implements standard JavaScript iteration protocols
  * - **Functional**: Rich API for map, filter, reduce-style operations
  *
  * **When to Use:**
+ *
  * - State management in functional applications
  * - Caching with immutable guarantees
  * - Data structures that need to be shared across components
@@ -202,156 +554,76 @@ type IMapInterface<K extends MapSetKeyType, V> = Readonly<{
  *
  * @template K The type of the keys in the map. Must extend MapSetKeyType.
  * @template V The type of the values in the map.
- *
- * @example
- * ```typescript
- * // Create an immutable map with initial data
- * let userPreferences = IMap.create<string, UserPreference>([
- *   ["theme", { value: "dark", lastModified: Date.now() }],
- *   ["language", { value: "en", lastModified: Date.now() }]
- * ]);
- *
- * console.log(userPreferences.get("theme").unwrapOr(defaultPreference));
- * console.log(userPreferences.size); // Output: 2
- *
- * // All operations return new instances - original is unchanged
- * const updated = userPreferences
- *   .set("notifications", { value: true, lastModified: Date.now() })
- *   .update("theme", pref => ({ ...pref, value: "light" }));
- *
- * console.log(userPreferences.has("notifications")); // false (original unchanged)
- * console.log(updated.has("notifications"));         // true (new instance)
- *
- * // Efficient iteration and transformation
- * for (const [key, preference] of updated) {
- *   console.log(`${key}: ${preference.value}`);
- * }
- *
- * // Functional transformations
- * const withTimestamps = updated.map((pref, key) => ({
- *   ...pref,
- *   accessedAt: Date.now()
- * }));
- *
- * // Type-safe operations with narrowing
- * const stringKeys = IMap.create<number | string, any>([[1, "a"], ["b", 2]]);
- * const onlyStringKeys = stringKeys.mapKeys(key =>
- *   typeof key === "string" ? key : key.toString()
- * );
- * ```
  */
 export type IMap<K extends MapSetKeyType, V> = Iterable<readonly [K, V]> & IMapInterface<K, V>;
-/**
- * Provides utility functions for IMap.
- */
+/** Provides utility functions for IMap. */
 export declare namespace IMap {
     /**
      * Creates a new IMap instance from an iterable of key-value pairs.
      *
-     * This factory function accepts any iterable of [key, value] tuples, including arrays,
-     * JavaScript Maps, other IMaps, or custom iterables. The resulting IMap will contain
-     * all the entries from the input iterable.
+     * This factory function accepts any iterable of [key, value] tuples,
+     * including arrays, JavaScript Maps, other IMaps, or custom iterables. The
+     * resulting IMap will contain all the entries from the input iterable.
      *
      * **Performance:** O(n) where n is the number of entries in the iterable.
      *
-     * @template K The type of the keys. Must extend MapSetKeyType.
-     * @template V The type of the values.
-     * @param iterable An iterable of key-value pairs (e.g., Array, Map, IMap, etc.)
-     * @returns A new IMap instance containing all entries from the iterable.
-     *
      * @example
-     * ```typescript
-     * // From array of tuples
-     * const userScores = IMap.create<string, number>([
-     *   ["alice", 95],
-     *   ["bob", 87],
-     *   ["charlie", 92]
+     *
+     * ```ts
+     * const map = IMap.create<string, number | string>([
+     *   ['id', 1],
+     *   ['status', 'active'],
      * ]);
-     * console.log(userScores.get("alice").unwrap()); // Output: 95
-     *
-     * // From JavaScript Map
-     * const jsMap = new Map([["config", { debug: true }], ["env", "production"]]);
-     * const config = IMap.create(jsMap);
-     * console.log(config.get("env").unwrap()); // Output: "production"
-     *
-     * // From another IMap (creates a copy)
-     * const originalMap = IMap.create<string, boolean>([["enabled", true]]);
-     * const copiedMap = IMap.create(originalMap);
-     * console.log(copiedMap.get("enabled").unwrap()); // Output: true
-     *
-     * // Empty map
-     * const emptyMap = IMap.create<string, number>([]);
-     * console.log(emptyMap.size); // Output: 0
-     *
-     * // From custom iterable
-     * function* generateEntries(): Generator<[string, number]> {
-     *   for (const i of range(3)) {
-     *     yield [`item${i}`, i * 10];
-     *   }
-     * }
-     * const generatedMap = IMap.create(generateEntries());
-     * console.log(generatedMap.size); // Output: 3
+     *
+     * assert(map.size === 2);
+     * assert.deepStrictEqual(map.get('status'), Optional.some('active'));
      * ```
+     *
+     * @template K The type of the keys. Must extend MapSetKeyType.
+     * @template V The type of the values.
+     * @param iterable An iterable of key-value pairs (e.g., Array, Map, IMap,
+     *   etc.)
+     * @returns A new IMap instance containing all entries from the iterable.
      */
     const create: <K extends MapSetKeyType, V>(iterable: Iterable<readonly [K, V]>) => IMap<K, V>;
     /**
      * Checks if two IMap instances are structurally equal.
      *
-     * Two IMaps are considered equal if they have the same size and contain exactly the same
-     * key-value pairs. The order of entries does not matter for equality comparison.
-     * Values are compared using JavaScript's `===` operator.
+     * Two IMaps are considered equal if they have the same size and contain
+     * exactly the same key-value pairs. The order of entries does not matter for
+     * equality comparison. Values are compared using JavaScript's `===`
+     * operator.
      *
      * **Performance:** O(n) where n is the size of the smaller map.
      *
-     * @template K The type of the keys.
-     * @template V The type of the values.
-     * @param a The first IMap instance to compare.
-     * @param b The second IMap instance to compare.
-     * @returns `true` if the maps contain exactly the same key-value pairs, `false` otherwise.
-     *
      * @example
-     * ```typescript
-     * // Basic equality comparison
-     * const preferences1 = IMap.create<string, boolean>([
-     *   ["darkMode", true],
-     *   ["notifications", false]
-     * ]);
-     * const preferences2 = IMap.create<string, boolean>([
-     *   ["darkMode", true],
-     *   ["notifications", false]
-     * ]);
-     * const preferences3 = IMap.create<string, boolean>([
-     *   ["notifications", false],
-     *   ["darkMode", true]  // Order doesn't matter
-     * ]);
-     *
-     * console.log(IMap.equal(preferences1, preferences2)); // true
-     * console.log(IMap.equal(preferences1, preferences3)); // true (order doesn't matter)
      *
-     * // Different values
-     * const preferences4 = IMap.create<string, boolean>([
-     *   ["darkMode", false],  // Different value
-     *   ["notifications", false]
+     * ```ts
+     * const first = IMap.create<'a' | 'b', number>([
+     *   ['a', 1],
+     *   ['b', 2],
      * ]);
-     * console.log(IMap.equal(preferences1, preferences4)); // false
      *
-     * // Different keys
-     * const preferences5 = IMap.create<string, boolean>([
-     *   ["darkMode", true],
-     *   ["sounds", false]  // Different key
+     * const second = IMap.create<'a' | 'b', number>([
+     *   ['b', 2],
+     *   ['a', 1],
      * ]);
-     * console.log(IMap.equal(preferences1, preferences5)); // false
      *
-     * // Empty maps
-     * const empty1 = IMap.create<string, number>([]);
-     * const empty2 = IMap.create<string, number>([]);
-     * console.log(IMap.equal(empty1, empty2)); // true
+     * const third = IMap.create<'a' | 'b', number>([
+     *   ['a', 1],
+     *   ['b', 3],
+     * ]);
      *
-     * // Note: For deep equality of object values, use a custom comparison
-     * const users1 = IMap.create<string, User>([["1", { name: "Alice" }]]);
-     * const users2 = IMap.create<string, User>([["1", { name: "Alice" }]]);
-     * console.log(IMap.equal(users1, users2)); // false (different object references)
+     * assert.ok(IMap.equal(first, second));
+     * assert.notOk(IMap.equal(first, third));
      * ```
+     *
+     * @template K The type of the keys.
+     * @template V The type of the values.
+     * @param a The first IMap instance to compare.
+     * @param b The second IMap instance to compare.
+     * @returns `true` if the maps contain exactly the same key-value pairs,
+     *   `false` otherwise.
      */
     const equal: <K extends MapSetKeyType, V>(a: IMap<K, V>, b: IMap<K, V>) => boolean;
 }