extra-iterator 0.7.0 → 0.9.0

package/dist/index.d.ts

@@ -187,6 +187,23 @@ export declare class ExtraIterator<T> extends Iterator<T, any, any> {
      *     // returns [[1, 2, 3], [4, 5, 6], [7]]
      */
     chunk(size: number): ExtraIterator<T[]>;
+    /**
+     * Groups the elements in this iterator into groups of variable size.
+     *
+     * This method calls the provided predicate function for each pair of adjacent elements in this iterator. It should
+     * return `true` if the elements should belong to the same group, or `false` if they should belong to different
+     * groups.
+     *
+     * The resulting iterator yields arrays of elements that belong to the same group.
+     *
+     * @example
+     *
+     * ExtraIterator.from([1, 1, 2, 3, 3, 3, 2, 2])
+     *     .chunkWith((lhs, rhs) => lhs === rhs)
+     *     .toArray()
+     *     // returns [[1, 1], [2], [3, 3, 3], [2, 2]]
+     */
+    chunkWith(predicate: (lhs: T, rhs: T, index: number, chunk: [T, ...T[]]) => boolean): ExtraIterator<T[]>;
     /**
      * Creates a new iterator that iterates on this iterator and the proviuded other iterator, yielding arrays of pairs
      * of elements from this iterator and the other.
@@ -321,6 +338,12 @@ export declare class ExtraIterator<T> extends Iterator<T, any, any> {
      *     // returns { _a: 2, _b: 4 }
      */
     collect<U>(collectfn: ((iter: Iterable<T>) => U)): U;
+    /**
+     * 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.
      *
@@ -337,7 +360,7 @@ export declare class ExtraIterator<T> extends Iterator<T, any, any> {
      * ExtraIterator.from([1, 2, 3]).uniqueness() // returns true
      * ExtraIterator.from([1, 2, 3, 1]).uniqueness() // returns false
      */
-    uniqueness(mapper?: (value: T) => unknown): boolean;
+    testUnique(mapper?: (value: T) => unknown): boolean;
     /**
      * Lazily executes a function over each element of this iterator as the values are iterated.
      *

package/dist/index.js

@@ -311,6 +311,41 @@ export class ExtraIterator extends Iterator {
             }
         }.call(this));
     }
+    /**
+     * Groups the elements in this iterator into groups of variable size.
+     *
+     * This method calls the provided predicate function for each pair of adjacent elements in this iterator. It should
+     * return `true` if the elements should belong to the same group, or `false` if they should belong to different
+     * groups.
+     *
+     * The resulting iterator yields arrays of elements that belong to the same group.
+     *
+     * @example
+     *
+     * ExtraIterator.from([1, 1, 2, 3, 3, 3, 2, 2])
+     *     .chunkWith((lhs, rhs) => lhs === rhs)
+     *     .toArray()
+     *     // returns [[1, 1], [2], [3, 3, 3], [2, 2]]
+     */
+    chunkWith(predicate) {
+        return ExtraIterator.from(function* () {
+            const first = this.next();
+            if (first.done) {
+                return;
+            }
+            let chunk = [first.value];
+            for (let left = first, right, index = 0; right = this.next(), !right.done; left = right, index++) {
+                if (predicate(left.value, right.value, index, chunk)) {
+                    chunk.push(left.value);
+                }
+                else {
+                    yield chunk;
+                    chunk = [right.value];
+                }
+            }
+            yield chunk;
+        }.call(this));
+    }
     /**
      * Creates a new iterator that iterates on this iterator and the proviuded other iterator, yielding arrays of pairs
      * of elements from this iterator and the other.
@@ -585,6 +620,14 @@ export class ExtraIterator extends Iterator {
     collect(collectfn) {
         return collectfn(this);
     }
+    /**
+     * 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.
      *
@@ -607,7 +650,7 @@ export class ExtraIterator extends Iterator {
      * ExtraIterator.from([1, 2, 3]).uniqueness() // returns true
      * ExtraIterator.from([1, 2, 3, 1]).uniqueness() // returns false
      */
-    uniqueness(mapper) {
+    testUnique(mapper) {
         const seen = new Set();
         for (let next; next = this.next(), !next.done;) {
             const value = mapper ? mapper(next.value) : next.value;

package/dist/index.test.js

@@ -150,6 +150,28 @@ describe('ExtraIterator', () => {
         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);
+        });
+    });
+    describe('chunkWith', () => {
+        it('should chunk using a comparer function', () => {
+            const result = ExtraIterator.from([1, 1, 2, 3, 3, 3, 2, 2])
+                .chunkWith((lhs, rhs) => lhs === rhs)
+                .toArray();
+            expect(result).toEqual([[1, 1], [2], [3, 3, 3], [2, 2]]);
+        });
+    });
     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.7.0",
+  "version": "0.9.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js",