extra-iterator 0.6.0 → 0.8.0

package/dist/index.d.ts

@@ -283,6 +283,9 @@ export declare class ExtraIterator<T> extends Iterator<T, any, any> {
      * The returned object is composed of keys generated by calling the provided callback function on each element of
      * this iterator, and the value for each key is an array containing all the elements that were assigned to that key.
      *
+     * This method is similar to {@link toMap}, but the returned object is a plain, null-prototype, object, instead of a
+     * `Map`.
+     *
      * @example
      *
      * ExtraIterator.from([1, 2, 3, 4, 5])
@@ -291,6 +294,20 @@ export declare class ExtraIterator<T> extends Iterator<T, any, any> {
      *  // returns { even: [2, 4], odd: [1, 3, 5] }
      */
     groupBy<K extends string | symbol>(callbackfn: (value: T, index: number) => K): Record<K, T[]>;
+    /**
+     * Groups elements into separate arrays and returns a Map containing each group.
+     *
+     * The returned Map is composed of keys generated by calling the provided callback function on each element of this
+     * iterator, and the value for each key is an array containing all the elements to which the callback function
+     * returned that key.
+     *
+     * This method is similart to {@link groupBy}, but the returned object is a Map instead of a plain object.
+     */
+    toMap<K extends string | symbol>(callbackfn: (value: T, index: number) => K): Map<K, T[]>;
+    /**
+     * Creates a set containing all the values yielded by this iterator.
+     */
+    toSet(): Set<T>;
     toChainOfResponsibilityFunction<ResultType = void | Promise<void>, ParamsType extends any[] = []>(invokeHandler: (handler: T, next: (...args: ParamsType) => ResultType, ...args: ParamsType) => ResultType): (...args: ParamsType) => ResultType;
     /**
      * Consumes the iterator and returns a value determined by calling the provided function using the iterator as
@@ -304,9 +321,16 @@ export declare class ExtraIterator<T> extends Iterator<T, any, any> {
      *     // returns { _a: 2, _b: 4 }
      */
     collect<U>(collectfn: ((iter: Iterable<T>) => U)): U;
-    toSortedBy(...keys: (keyof T)[]): T[];
+    /**
+     * Sums the numeric value of all elements in the iterator and returns the total.
+     *
+     * @example ExtraIterator.from([5, 8, 13]).sum() // returns 26
+     */
+    sum(): number;
     /**
      * Consumes the iterator and returns the number of elements it contained.
+     *
+     * @example ExtraIterator.from([1, 2, 3, 4]).count() // returns 4
      */
     count(): number;
     /**

package/dist/index.js

@@ -504,6 +504,9 @@ export class ExtraIterator extends Iterator {
      * The returned object is composed of keys generated by calling the provided callback function on each element of
      * this iterator, and the value for each key is an array containing all the elements that were assigned to that key.
      *
+     * This method is similar to {@link toMap}, but the returned object is a plain, null-prototype, object, instead of a
+     * `Map`.
+     *
      * @example
      *
      * ExtraIterator.from([1, 2, 3, 4, 5])
@@ -522,6 +525,37 @@ export class ExtraIterator extends Iterator {
         }
         return result;
     }
+    /**
+     * Groups elements into separate arrays and returns a Map containing each group.
+     *
+     * The returned Map is composed of keys generated by calling the provided callback function on each element of this
+     * iterator, and the value for each key is an array containing all the elements to which the callback function
+     * returned that key.
+     *
+     * This method is similart to {@link groupBy}, but the returned object is a Map instead of a plain object.
+     */
+    toMap(callbackfn) {
+        const result = new Map();
+        for (let index = 0, next; next = this.next(), !next.done; index++) {
+            const key = callbackfn(next.value, index);
+            const array = result.get(key);
+            if (!array) {
+                result.set(key, [next.value]);
+            }
+            else {
+                array.push(next.value);
+            }
+        }
+        return result;
+    }
+    /**
+     * Creates a set containing all the values yielded by this iterator.
+     */
+    toSet() {
+        const result = new Set();
+        this.forEach(value => result.add(value));
+        return result;
+    }
     toChainOfResponsibilityFunction(invokeHandler) {
         const handlers = this.toArray();
         return (...initialArgs) => {
@@ -551,20 +585,18 @@ export class ExtraIterator extends Iterator {
     collect(collectfn) {
         return collectfn(this);
     }
-    toSortedBy(...keys) {
-        return this.toArray()
-            .sort((a, b) => {
-            for (const key of keys) {
-                if (a[key] < b[key])
-                    return -1;
-                if (a[key] > b[key])
-                    return 1;
-            }
-            return 0;
-        });
+    /**
+     * Sums the numeric value of all elements in the iterator and returns the total.
+     *
+     * @example ExtraIterator.from([5, 8, 13]).sum() // returns 26
+     */
+    sum() {
+        return this.reduce((a, b) => a + Number(b), 0);
     }
     /**
      * Consumes the iterator and returns the number of elements it contained.
+     *
+     * @example ExtraIterator.from([1, 2, 3, 4]).count() // returns 4
      */
     count() {
         let count = 0;

package/dist/index.test.js

@@ -126,11 +126,44 @@ describe('ExtraIterator', () => {
             b: ['banana'],
         });
     });
+    it('should convert to a Map', () => {
+        const iterator = ExtraIterator.from([{ key: 'a', value: 1 }, { key: 'b', value: 2 }, { key: 'a', value: 3 }]);
+        const map = iterator.toMap(item => item.key);
+        expect(map).toBeInstanceOf(Map);
+        expect(map).toEqual(new Map([
+            ['a', [{ key: 'a', value: 1 }, { key: 'a', value: 3 }]],
+            ['b', [{ key: 'b', value: 2 }]],
+        ]));
+    });
+    it('should convert to a Set', () => {
+        const iterator = ExtraIterator.from([3, 1, 3, 2, 2, 1, 3]);
+        const set = iterator.toSet();
+        expect(set).toBeInstanceOf(Set);
+        expect(set.size).toBe(3);
+        expect(set.has(1)).toBe(true);
+        expect(set.has(2)).toBe(true);
+        expect(set.has(3)).toBe(true);
+        expect(set).toEqual(new Set([3, 1, 2]));
+    });
     it('should collect values using a custom collector', () => {
         const iterator = ExtraIterator.from([1, 2, 3]);
         const sum = iterator.collect(iter => Array.from(iter).reduce((a, b) => a + b, 0));
         expect(sum).toBe(6);
     });
+    describe('sum', () => {
+        it('should sum numbers', () => {
+            const iter = ExtraIterator.from([5, 8, 13]);
+            expect(iter.sum()).toBe(26);
+        });
+        it('should sum the numeric value of objects', () => {
+            const iter = ExtraIterator.from([
+                { valueOf: () => 5 },
+                { valueOf: () => 8 },
+                { valueOf: () => 13 },
+            ]);
+            expect(iter.sum()).toBe(26);
+        });
+    });
     it('should create a chain of responsibility function', () => {
         const humanizeDuration = ExtraIterator.from([
             (next, miliseconds) => miliseconds < 1000 ? `${miliseconds} miliseconds` : next(miliseconds / 1000),

package/package.json

@@ -3,7 +3,7 @@
   "description": "An extension of the Iterator class with additional utility helper functions.",
   "author": "Leonardo Raele <leonardoraele@gmail.com>",
   "license": "MIT",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js",

package/dist/chain-of-responsibility.js

@@ -1 +0,0 @@
-"use strict";