extra-iterator 0.4.1 → 0.5.0

package/dist/index.d.ts

@@ -200,6 +200,18 @@ export declare class ExtraIterator<T> extends Iterator<T, any, any> {
      *     // returns [1, 'a', 2, 'a', 3, 'a', 4]
      */
     interpose<U>(separator: U): ExtraIterator<T | U>;
+    /**
+     * Creates a new iterator that yields the values of this iterator interposed by separator values produced by calling
+     * the callback function provided as argument.
+     *
+     * @example
+     *
+     * ExtraIterator.from([2, 3, 5, 8])
+     *     .interposeWith((lhs, rhs) => (lhs + rhs) / 2)
+     *     .toArray()
+     *     // returns [2, 2.5, 3, 4, 5, 6.5, 8]
+     */
+    interposeWith<U>(separatorProvider: (lhs: T, rhs: T, index: number) => U): ExtraIterator<T | U>;
     /**
      * Creates a new iterator that yields the values of this iterator and the values of the provided iterator
      * interleaved (alternating). The elements of this iterator always come before the elements of the other iterator.

package/dist/index.js

@@ -330,6 +330,28 @@ export class ExtraIterator extends Iterator {
             }
         }.call(this));
     }
+    /**
+     * Creates a new iterator that yields the values of this iterator interposed by separator values produced by calling
+     * the callback function provided as argument.
+     *
+     * @example
+     *
+     * ExtraIterator.from([2, 3, 5, 8])
+     *     .interposeWith((lhs, rhs) => (lhs + rhs) / 2)
+     *     .toArray()
+     *     // returns [2, 2.5, 3, 4, 5, 6.5, 8]
+     */
+    interposeWith(separatorProvider) {
+        return ExtraIterator.from(function* () {
+            for (let previous = this.next(), next, index = 0; !previous.done; previous = next, index++) {
+                yield previous.value;
+                next = this.next();
+                if (!next.done) {
+                    yield separatorProvider(previous.value, next.value, index);
+                }
+            }
+        }.call(this));
+    }
     /**
      * Creates a new iterator that yields the values of this iterator and the values of the provided iterator
      * interleaved (alternating). The elements of this iterator always come before the elements of the other iterator.

package/dist/index.test.js

@@ -57,6 +57,10 @@ describe('ExtraIterator', () => {
         const iterator = ExtraIterator.from([1, 2, 3]).interpose(0);
         expect(iterator.toArray()).toEqual([1, 0, 2, 0, 3]);
     });
+    it('should interpose with a function', () => {
+        const iterator = ExtraIterator.from([1, 2, 3, 5, 8, 13]).interposeWith((a, b) => (a + b) / 2);
+        expect(iterator.toArray()).toEqual([1, 1.5, 2, 2.5, 3, 4, 5, 6.5, 8, 10.5, 13]);
+    });
     it('should chunk values into groups of a given size', () => {
         const iterator = ExtraIterator.from([1, 2, 3, 4]).chunk(2);
         expect(iterator.toArray()).toEqual([[1, 2], [3, 4]]);

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.4.1",
+  "version": "0.5.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js",