@byloth/core 2.0.0 → 2.0.2

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

@@ -30,6 +30,9 @@ import type { MaybeAsyncKeyedIteratee, MaybeAsyncKeyedReducer } from "./types.js
  * This is particularly useful when you need to group elements and
  * then perform specific operations on the groups themselves.
  *
+ * ---
+ *
+ * @example
  * ```ts
  * const elements = fetch([...]); // Promise<[-3, -1, 0, 2, 3, 5, 6, 8]>;
  * const results = new SmartAsyncIterator(elements)
@@ -39,6 +42,8 @@ import type { MaybeAsyncKeyedIteratee, MaybeAsyncKeyedReducer } from "./types.js
  * console.log(await results.toObject()); // { odd: 4, even: 4 }
  * ```
  *
+ * ---
+ *
  * @template K The type of the keys used to group the elements.
  * @template T The type of the elements to aggregate.
  */
@@ -52,10 +57,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 +73,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 +90,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 +108,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * });
      * ```
      *
+     * ---
+     *
      * @param iterator The iterator to aggregate.
      */
     public constructor(iterator: Iterator<[K, T]>);
@@ -97,6 +117,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 +135,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * });
      * ```
      *
+     * ---
+     *
      * @param iterator The iterator to aggregate.
      */
     public constructor(iterator: AsyncIterator<[K, T]>);
@@ -119,6 +144,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 +159,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * });
      * ```
      *
+     * ---
+     *
      * @param generatorFn The generator function to aggregate.
      */
     public constructor(generatorFn: GeneratorFunction<[K, T]>);
@@ -138,6 +168,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 +183,8 @@ export default class AggregatedAsyncIterator<K extends PropertyKey, T>
      * });
      * ```
      *
+     * ---
+     *
      * @param generatorFn The generator function to aggregate.
      */
     public constructor(generatorFn: AsyncGeneratorFunction<[K, T]>);
@@ -157,10 +192,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 +222,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 +233,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 +272,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 +283,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 +319,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 +330,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 +348,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 +359,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 +402,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 +413,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 +452,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 +463,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 +486,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 +497,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 +524,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 +535,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 +595,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 +610,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 +653,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 +664,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 +704,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 +715,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 +752,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 +763,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 +785,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 +796,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 +844,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 +855,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 +875,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 +886,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 +916,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 +927,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 +956,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 +969,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 +1000,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 +1012,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 +1049,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 +1060,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 +1093,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 +1104,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 +1124,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 +1135,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 +1155,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 +1165,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 +1182,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 +1192,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 +1217,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 +1227,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[]>>