extra-iterator 0.9.2 → 0.10.3

package/dist/index.d.ts

@@ -36,6 +36,22 @@ export declare class ExtraIterator<T> extends Iterator<T, any, any> {
         start?: number | undefined;
         interval?: number | undefined;
     }): ExtraIterator<number>;
+    /**
+     * Creates an iterator that yields numbers in a "from-to" range. (exclusive)
+     *
+     * Chain the returned iterator into the {@link append} method to create an inclusive range. (or {@link prepend} if
+     * the range is decremental)
+     *
+     * The third argument is an optional step that defines the increment (or decrement) between each yielded number.
+     *
+     * @example
+     * ExtraIterator.range(5, 10).toArray() // returns [5, 6, 7, 8, 9]
+     * ExtraIterator.range(5, 10).append(10).toArray() // returns [5, 6, 7, 8, 9, 10]
+     * ExtraIterator.range(1, 10, 2).toArray() // returns [1, 3, 5, 7, 9]
+     * ExtraIterator.range(0, 1, 0.25).toArray() // returns [0, 0.25, 0.5, 0.75]
+     * ExtraIterator.range(10, 0, -2).toArray() // returns [10, 8, 6, 4, 2]
+     */
+    static range(start: number, end: number, step?: number): ExtraIterator<number>;
     /**
      * Creates an iterator that repeatedly yields the provided value.
      *
@@ -45,12 +61,10 @@ export declare class ExtraIterator<T> extends Iterator<T, any, any> {
      */
     static repeat<T>(value: T): ExtraIterator<T>;
     /**
-     * Generates random cryptographically strong random numbers.
+     * Generates an infinite sequence of cryptographically strong random bytes using `crypto.getRandomValues`. Each
+     * yielded value is a number in between 0 and 255 (inclusive).
      *
      * > ⚠ This iterator is infinite. Use {@link take} method if you want a specific number of values.
-     *
-     * @param param0
-     * @returns
      */
     static random({ bufferSize }?: {
         bufferSize?: number | undefined;
@@ -310,7 +324,7 @@ export declare class ExtraIterator<T> extends Iterator<T, any, any> {
      *  .toArray()
      *  // returns { even: [2, 4], odd: [1, 3, 5] }
      */
-    groupBy<K extends string | symbol>(callbackfn: (value: T, index: number) => K): Record<K, T[]>;
+    groupBy<K extends string | symbol>(callbackfn: (value: T, index: number) => K): Partial<Record<K, T[]>>;
     /**
      * Groups elements into separate arrays and returns a Map containing each group.
      *

package/dist/index.js

@@ -44,6 +44,38 @@ export class ExtraIterator extends Iterator {
             }
         }());
     }
+    /**
+     * Creates an iterator that yields numbers in a "from-to" range. (exclusive)
+     *
+     * Chain the returned iterator into the {@link append} method to create an inclusive range. (or {@link prepend} if
+     * the range is decremental)
+     *
+     * The third argument is an optional step that defines the increment (or decrement) between each yielded number.
+     *
+     * @example
+     * ExtraIterator.range(5, 10).toArray() // returns [5, 6, 7, 8, 9]
+     * ExtraIterator.range(5, 10).append(10).toArray() // returns [5, 6, 7, 8, 9, 10]
+     * ExtraIterator.range(1, 10, 2).toArray() // returns [1, 3, 5, 7, 9]
+     * ExtraIterator.range(0, 1, 0.25).toArray() // returns [0, 0.25, 0.5, 0.75]
+     * ExtraIterator.range(10, 0, -2).toArray() // returns [10, 8, 6, 4, 2]
+     */
+    static range(start, end, step = 1) {
+        return ExtraIterator.from(function* () {
+            if (Math.abs(step) < Number.EPSILON) {
+                throw new Error('Failed to create range. Cause: Range step cannot be 0.');
+            }
+            else if (step > 0) {
+                for (let i = start; i < end; i += step) {
+                    yield i;
+                }
+            }
+            else {
+                for (let i = start; i > end; i += step) {
+                    yield i;
+                }
+            }
+        }());
+    }
     /**
      * Creates an iterator that repeatedly yields the provided value.
      *
@@ -59,18 +91,16 @@ export class ExtraIterator extends Iterator {
         }());
     }
     /**
-     * Generates random cryptographically strong random numbers.
+     * Generates an infinite sequence of cryptographically strong random bytes using `crypto.getRandomValues`. Each
+     * yielded value is a number in between 0 and 255 (inclusive).
      *
      * > ⚠ This iterator is infinite. Use {@link take} method if you want a specific number of values.
-     *
-     * @param param0
-     * @returns
      */
     static random({ bufferSize = 1024 } = {}) {
         const buffer = new Uint8Array(bufferSize);
         return new ExtraIterator(function* () {
             globalThis.crypto.getRandomValues(buffer);
-            yield* new Float64Array(buffer);
+            yield* new Uint8Array(buffer);
         }())
             .loop();
     }
@@ -550,15 +580,7 @@ export class ExtraIterator extends Iterator {
      *  // returns { even: [2, 4], odd: [1, 3, 5] }
      */
     groupBy(callbackfn) {
-        const result = Object.create(null);
-        for (let index = 0, next; next = this.next(), !next.done; index++) {
-            const key = callbackfn(next.value, index);
-            if (!result[key]) {
-                result[key] = [];
-            }
-            result[key].push(next.value);
-        }
-        return result;
+        return this.collect(items => Object.groupBy(items, callbackfn));
     }
     /**
      * Groups elements into separate arrays and returns a Map containing each group.
@@ -570,26 +592,13 @@ export class ExtraIterator extends Iterator {
      * 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;
+        return this.collect(items => Map.groupBy(items, callbackfn));
     }
     /**
      * Creates a set containing all the values yielded by this iterator.
      */
     toSet() {
-        const result = new Set();
-        this.forEach(value => result.add(value));
-        return result;
+        return new Set(this);
     }
     toChainOfResponsibilityFunction(invokeHandler) {
         const handlers = this.toArray();

package/dist/index.test.js

@@ -26,9 +26,9 @@ describe('ExtraIterator', () => {
         expect(iterator.toArray()).toEqual(['x', 'x', 'x']);
     });
     it('should yield random values', () => {
-        const values = ExtraIterator.random().take(5).toArray();
-        expect(values.length).toBe(5);
-        expect(values.every(value => typeof value === 'number')).toBe(true);
+        const values = ExtraIterator.random().take(10000).toArray();
+        expect(values.length).toBe(10000);
+        expect(values.every(value => typeof value === 'number' && value >= 0 && value < 256)).toBe(true);
     });
     it('should filter values based on a predicate', () => {
         const iterator = ExtraIterator.from([1, 2, 3, 4]).filter(x => x % 2 === 0);
@@ -195,4 +195,11 @@ describe('ExtraIterator', () => {
         const iterator = ExtraIterator.from([1, 2, 3]).loop(3);
         expect(iterator.toArray()).toEqual([1, 2, 3, 1, 2, 3, 1, 2, 3]);
     });
+    it('should iterate over ranges', () => {
+        expect(ExtraIterator.range(5, 10).toArray()).toEqual([5, 6, 7, 8, 9]);
+        expect(ExtraIterator.range(5, 10).append(10).toArray()).toEqual([5, 6, 7, 8, 9, 10]);
+        expect(ExtraIterator.range(1, 10, 2).toArray()).toEqual([1, 3, 5, 7, 9]);
+        expect(ExtraIterator.range(0, 1, 0.25).toArray()).toEqual([0, 0.25, 0.5, 0.75]);
+        expect(ExtraIterator.range(10, 0, -2).toArray()).toEqual([10, 8, 6, 4, 2]);
+    });
 });

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