@byloth/core 2.0.0 → 2.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byloth/core",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "An unopinionated collection of useful functions and classes that I use widely in all my projects. 🔧",
   "keywords": [
     "Core",
@@ -31,8 +31,8 @@
     "dist",
     "src"
   ],
-  "main": "./dist/core.umd.cjs",
-  "module": "./dist/core.js",
+  "main": "dist/core.umd.cjs",
+  "module": "dist/core.js",
   "exports": {
     ".": {
       "import": {
@@ -45,16 +45,17 @@
       }
     }
   },
-  "types": "./src/index.ts",
+  "types": "src/index.ts",
   "devDependencies": {
     "@byloth/eslint-config-typescript": "^3.1.0",
-    "@eslint/compat": "^1.2.6",
-    "@types/node": "^22.13.0",
+    "@eslint/compat": "^1.2.7",
+    "@types/node": "^22.13.11",
+    "eslint": "^9.23.0",
     "husky": "^9.1.7",
     "jsdom": "^26.0.0",
-    "typescript": "^5.7.3",
-    "vite": "^6.0.11",
-    "vitest": "^3.0.4"
+    "typescript": "^5.8.2",
+    "vite": "^6.2.2",
+    "vitest": "^3.0.9"
   },
   "scripts": {
     "dev": "vite",

package/src/index.ts

@@ -1,4 +1,4 @@
-export const VERSION = "2.0.0";
+export const VERSION = "2.0.1";
 
 export type { Constructor, Interval, Timeout } from "./core/types.js";
 

package/src/models/aggregators/aggregated-async-iterator.ts

@@ -52,10 +52,15 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
     /**
      * Initializes a new instance of the {@link AggregatedAsyncIterator} class.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const iterator = new AggregatedAsyncIterator<string, number>([["A", 1], ["B", 2], ["A", 3], ["C", 4], ["B", 5]]);
      * ```
      *
+     * ---
+     *
      * @param iterable The iterable to aggregate.
      */
     public constructor(iterable: Iterable<[K, T]>);
@@ -63,11 +68,16 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
     /**
      * Initializes a new instance of the {@link AggregatedAsyncIterator} class.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const elements = fetch([...]); // Promise<[["A", 1], ["B", 2], ["A", 3], ["C", 4], ["B", 5]]>
      * const iterator = new AggregatedAsyncIterator<string, number>(elements);
      * ```
      *
+     * ---
+     *
      * @param iterable The iterable to aggregate.
      */
     public constructor(iterable: AsyncIterable<[K, T]>);
@@ -75,6 +85,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
     /**
      * Initializes a new instance of the {@link AggregatedAsyncIterator} class.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * import { Random } from "@byloth/core";
      *
@@ -90,6 +103,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * });
      * ```
      *
+     * ---
+     *
      * @param iterator The iterator to aggregate.
      */
     public constructor(iterator: Iterator<[K, T]>);
@@ -97,6 +112,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
     /**
      * Initializes a new instance of the {@link AggregatedAsyncIterator} class.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * import { Random } from "@byloth/core";
      *
@@ -112,6 +130,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * });
      * ```
      *
+     * ---
+     *
      * @param iterator The iterator to aggregate.
      */
     public constructor(iterator: AsyncIterator<[K, T]>);
@@ -119,6 +139,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
     /**
      * Initializes a new instance of the {@link AggregatedAsyncIterator} class.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * import { range, Random } from "@byloth/core";
      *
@@ -131,6 +154,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * });
      * ```
      *
+     * ---
+     *
      * @param generatorFn The generator function to aggregate.
      */
     public constructor(generatorFn: GeneratorFunction<[K, T]>);
@@ -138,6 +163,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
     /**
      * Initializes a new instance of the {@link AggregatedAsyncIterator} class.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * import { range, Random } from "@byloth/core";
      *
@@ -150,6 +178,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * });
      * ```
      *
+     * ---
+     *
      * @param generatorFn The generator function to aggregate.
      */
     public constructor(generatorFn: AsyncGeneratorFunction<[K, T]>);
@@ -157,10 +187,15 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
     /**
      * Initializes a new instance of the {@link AggregatedAsyncIterator} class.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const iterator = new AggregatedAsyncIterator(asyncKeyedValues);
      * ```
      *
+     * ---
+     *
      * @param argument The iterable, iterator or generator function to aggregate.
      */
     public constructor(argument: MaybeAsyncIteratorLike<[K, T]> | MaybeAsyncGeneratorFunction<[K, T]>);
@@ -182,6 +217,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * object that will contain all the boolean results for each group.  
      * If the iterator is infinite, the method will never return.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -190,6 +228,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: false, even: true }
      * ```
      *
+     * ---
+     *
      * @param predicate The condition to check for each element of the iterator.
      *
      * @returns
@@ -227,6 +267,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * object that will contain all the boolean results for each group.  
      * If the iterator is infinite, the method will never return.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-5, -4, -3, -2, -1, 0])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -235,6 +278,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: false, even: true }
      * ```
      *
+     * ---
+     *
      * @param predicate The condition to check for each element of the iterator.
      *
      * @returns
@@ -269,6 +314,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This means that the original iterator won't be consumed until the
      * new one is and that consuming one of them will consume the other as well.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -277,6 +325,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: [3, 5], even: [0, 2, 6, 8] }
      * ```
      *
+     * ---
+     *
      * @param predicate The condition to check for each element of the iterator.
      *
      * @returns A new {@link AggregatedAsyncIterator} containing the elements that satisfy the condition.
@@ -293,6 +343,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This means that the original iterator won't be consumed until the
      * new one is and that consuming one of them will consume the other as well.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, "-1", 0, "2", "3", 5, 6, "8"])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -301,6 +354,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: [-3, 5], even: [0, 6] }
      * ```
      *
+     * ---
+     *
      * @template S
      * The type of the elements that satisfy the condition.  
      * This allows the type-system to infer the correct type of the new iterator.
@@ -342,6 +397,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This means that the original iterator won't be consumed until the
      * new one is and that consuming one of them will consume the other as well.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -350,6 +408,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: [3, 1, 3, 5], even: [0, 2, 6, 8] }
      * ```
      *
+     * ---
+     *
      * @template V The type of the elements after the transformation.
      *
      * @param iteratee The transformation function to apply to each element of the iterator.
@@ -387,6 +447,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * object that will contain all the reduced results for each group.  
      * If the iterator is infinite, the method will never return.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -395,6 +458,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: 4, even: 16 }
      * ```
      *
+     * ---
+     *
      * @param reducer The reducer function to apply to each element of the iterator.
      *
      * @returns
@@ -416,6 +481,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * object that will contain all the reduced results for each group.  
      * If the iterator is infinite, the method will never return.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -424,6 +492,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: 4, even: 16 }
      * ```
      *
+     * ---
+     *
      * @template A The type of the accumulator value which will also be the final result of the reduction.
      *
      * @param reducer The reducer function to apply to each element of the iterator.
@@ -449,6 +519,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * object that will contain all the reduced results for each group.  
      * If the iterator is infinite, the method will never return.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -457,6 +530,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: { value: 4 }, even: { value: 16 } }
      * ```
      *
+     * ---
+     *
      * @template A The type of the accumulator value which will also be the final result of the reduction.
      *
      * @param reducer The reducer function to apply to each element of the iterator.
@@ -515,6 +590,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This means that the original iterator won't be consumed until the
      * new one is and that consuming one of them will consume the other as well.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([[-3, -1], 0, 2, 3, 5, [6, 8]])
      *      .groupBy(async (values) =>
@@ -527,6 +605,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: [-3, -1, 3, 5], even: [0, 2, 6, 8] }
      * ```
      *
+     * ---
+     *
      * @template V The type of the elements after the transformation.
      *
      * @param iteratee The transformation function to apply to each element of the iterator.
@@ -568,6 +648,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This means that the original iterator won't be consumed until the
      * new one is and that consuming one of them will consume the other as well.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -576,6 +659,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: [3, 5], even: [6, 8] }
      * ```
      *
+     * ---
+     *
      * @param count The number of elements to drop from the beginning of each group.
      *
      * @returns A new {@link AggregatedAsyncIterator} containing the remaining elements.
@@ -614,6 +699,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This means that the original iterator won't be consumed until the
      * new one is and that consuming one of them will consume the other as well.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -622,7 +710,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: [-3, -1], even: [0, 2] }
      * ```
      *
-     * @param count The number of elements to take from the beginning of each group.
+     * ---
+     *
+     * @param limit The number of elements to take from the beginning of each group.
      *
      * @returns A new {@link AggregatedAsyncIterator} containing the taken elements.
      */
@@ -657,6 +747,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * object that will contain the first element that satisfies the condition for each group.  
      * If the iterator is infinite, the method will never return.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -665,6 +758,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: 3, even: 2 }
      * ```
      *
+     * ---
+     *
      * @param predicate The condition to check for each element of the iterator.
      *
      * @returns
@@ -685,6 +780,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * object that will contain the first element that satisfies the condition for each group.  
      * If the iterator is infinite, the method will never return.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number | string>([-3, "-1", 0, "2", "3", 5, 6, "8"])
      *     .groupBy(async (value) => Number(value) % 2 === 0 ? "even" : "odd")
@@ -693,6 +791,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: -3, even: 0 }
      * ```
      *
+     * ---
+     *
      * @template S
      * The type of the elements that satisfy the condition.  
      * This allows the type-system to infer the correct type of the new iterator.
@@ -739,6 +839,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This means that the original iterator won't be consumed until the
      * new one is and that consuming one of them will consume the other as well.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, 0, 2, -1, 3])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -747,6 +850,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(results.toObject()); // { odd: [[0, -3], [1, -1], [2, 3]], even: [[0, 0], [1, 2]] }
      * ```
      *
+     * ---
+     *
      * @returns A new {@link AggregatedAsyncIterator} containing the enumerated elements.
      */
     public enumerate(): AggregatedAsyncIterator<K, [number, T]>
@@ -765,6 +870,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This means that the original iterator won't be consumed until the
      * new one is and that consuming one of them will consume the other as well.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 6, -3, -1, 0, 5, 6, 8, 0, 2])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -773,6 +881,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: [-3, -1, 3, 5], even: [0, 2, 6, 8] }
      * ```
      *
+     * ---
+     *
      * @returns A new {@link AggregatedAsyncIterator} containing only the unique elements.
      */
     public unique(): AggregatedAsyncIterator<K, T>
@@ -801,6 +911,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      *
      * If the iterator is infinite, the method will never return.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -809,6 +922,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { odd: 4, even: 4 }
      * ```
      *
+     * ---
+     *
      * @returns
      * A {@link Promise} resolving to a new {@link ReducedIterator} containing the number of elements for each group.
      */
@@ -836,6 +951,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This method will consume the entire iterator in the process.  
      * If the iterator is infinite, the method will never return.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const aggregator = new SmartAsyncIterator<number>([-3, 0, 2, -1, 3])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd");
@@ -846,6 +964,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * };
      * ```
      *
+     * ---
+     *
      * @param iteratee The function to execute for each element of the iterator.
      *
      * @returns A {@link Promise} that will resolve once the iteration is complete.
@@ -875,6 +995,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This means that the original iterator won't be consumed until the
      * new one is and that consuming one of them will consume the other as well.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const results = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -884,6 +1007,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await results.toObject()); // { "+": [1, 0, 3, 6], "-": [-3, -2, -5, -8] }
      * ```
      *
+     * ---
+     *
      * @template J The type of the new key.
      *
      * @param iteratee The function to determine the new key for each element of the iterator.
@@ -919,6 +1044,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This means that the original iterator won't be consumed until the
      * new one is and that consuming one of them will consume the other as well.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const keys = new SmartAsyncIterator([-3, Symbol(), "A", { }, null, [1 , 2, 3], false])
      *     .groupBy(async (value) => typeof value)
@@ -927,6 +1055,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await keys.toArray()); // ["number", "symbol", "string", "object", "boolean"]
      * ```
      *
+     * ---
+     *
      * @returns A new {@link SmartAsyncIterator} containing all the keys of the iterator.
      */
     public keys(): SmartAsyncIterator<K>
@@ -958,6 +1088,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This means that the original iterator won't be consumed until the
      * new one is and that consuming one of them will consume the other as well.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const entries = new SmartAsyncIterator<number>([-3, 0, 2, -1, 3])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -966,6 +1099,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await entries.toArray()); // [["odd", -3], ["even", 0], ["even", 2], ["odd", -1], ["odd", 3]]
      * ```
      *
+     * ---
+     *
      * @returns A new {@link SmartAsyncIterator} containing all the entries of the iterator.
      */
     public entries(): SmartAsyncIterator<[K, T]>
@@ -984,6 +1119,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * This means that the original iterator won't be consumed until the
      * new one is and that consuming one of them will consume the other as well.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const values = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd")
@@ -992,6 +1130,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await values.toArray()); // [-3, -1, 0, 2, 3, 5, 6, 8]
      * ```
      *
+     * ---
+     *
      * @returns A new {@link SmartAsyncIterator} containing all the values of the iterator.
      */
     public values(): SmartAsyncIterator<T>
@@ -1010,6 +1150,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      *
      * If the iterator is infinite, the method will never return.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const aggregator = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd");
@@ -1017,6 +1160,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await aggregator.toArray()); // [[-3, -1, 3, 5], [0, 2, 6, 8]]
      * ```
      *
+     * ---
+     *
      * @returns A {@link Promise} resolving to an {@link Array} containing all the values of the iterator.
      */
     public async toArray(): Promise<T[][]>
@@ -1032,6 +1177,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      *
      * If the iterator is infinite, the method will never return.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const aggregator = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd");
@@ -1039,6 +1187,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await aggregator.toMap()); // Map(2) { "odd" => [-3, -1, 3, 5], "even" => [0, 2, 6, 8] }
      * ```
      *
+     * ---
+     *
      * @returns A {@link Promise} resolving to a {@link Map} containing all the entries of the iterator.
      */
     public async toMap(): Promise<Map<K, T[]>>
@@ -1062,6 +1212,9 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      *
      * If the iterator is infinite, the method will never return.
      *
+     * ---
+     *
+     * @example
      * ```ts
      * const aggregator = new SmartAsyncIterator<number>([-3, -1, 0, 2, 3, 5, 6, 8])
      *     .groupBy(async (value) => value % 2 === 0 ? "even" : "odd");
@@ -1069,6 +1222,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * console.log(await aggregator.toObject()); // { odd: [-3, -1, 3, 5], even: [0, 2, 6, 8] }
      * ```
      *
+     * ---
+     *
      * @returns A {@link Promise} resolving to an object containing all the entries of the iterator.
      */
     public async toObject(): Promise<Record<K, T[]>>