extra-iterator 0.10.3 → 0.11.0

package/dist/index.d.ts

@@ -46,12 +46,21 @@ export declare class ExtraIterator<T> extends Iterator<T, any, any> {
      *
      * @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]
+     * ExtraIterator.range(5, 10, { inclusive: true }).toArray() // returns [5, 6, 7, 8, 9, 10]
+     *
+     * // Counting down:
+     * ExtraIterator.range(10, 0).toArray() // return [10, 9, 8, 7, 6, 5, 4, 3, 2, 1]
+     * ExtraIterator.range(10, 0, { inclusive: true }).toArray() // return [10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
+     *
+     * // Custom stepping value:
+     * ExtraIterator.range(1, 10, { step: 2 }).toArray() // returns [1, 3, 5, 7, 9]
+     * ExtraIterator.range(0, 1, { step: 0.25 }).toArray() // returns [0, 0.25, 0.5, 0.75]
+     * ExtraIterator.range(10, 0, { step: 2 }).toArray() // returns [10, 8, 6, 4, 2]
      */
-    static range(start: number, end: number, step?: number): ExtraIterator<number>;
+    static range(start: number, end: number, { inclusive, step }?: {
+        inclusive?: boolean | undefined;
+        step?: number | undefined;
+    }): ExtraIterator<number>;
     /**
      * Creates an iterator that repeatedly yields the provided value.
      *

package/dist/index.js

@@ -54,23 +54,30 @@ export class ExtraIterator extends Iterator {
      *
      * @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]
+     * ExtraIterator.range(5, 10, { inclusive: true }).toArray() // returns [5, 6, 7, 8, 9, 10]
+     *
+     * // Counting down:
+     * ExtraIterator.range(10, 0).toArray() // return [10, 9, 8, 7, 6, 5, 4, 3, 2, 1]
+     * ExtraIterator.range(10, 0, { inclusive: true }).toArray() // return [10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
+     *
+     * // Custom stepping value:
+     * ExtraIterator.range(1, 10, { step: 2 }).toArray() // returns [1, 3, 5, 7, 9]
+     * ExtraIterator.range(0, 1, { step: 0.25 }).toArray() // returns [0, 0.25, 0.5, 0.75]
+     * ExtraIterator.range(10, 0, { step: 2 }).toArray() // returns [10, 8, 6, 4, 2]
      */
-    static range(start, end, step = 1) {
+    static range(start, end, { inclusive = false, step = 1 } = {}) {
         return ExtraIterator.from(function* () {
-            if (Math.abs(step) < Number.EPSILON) {
+            step = Math.abs(step);
+            if (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) {
+            else if (end > start) {
+                for (let i = start; inclusive ? i <= end : i < end; i += step) {
                     yield i;
                 }
             }
             else {
-                for (let i = start; i > end; i += step) {
+                for (let i = start; inclusive ? i >= end : i > end; i -= step) {
                     yield i;
                 }
             }

package/dist/index.test.js

@@ -1,7 +1,7 @@
 import { ExtraIterator } from './index';
 import { describe, it } from 'node:test';
 import { expect } from 'expect';
-describe('ExtraIterator', () => {
+describe(ExtraIterator.name, () => {
     it('should create an ExtraIterator from an array', () => {
         const array = [1, 2, 3];
         const iterator = ExtraIterator.from(array);
@@ -195,11 +195,25 @@ 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]);
+    describe(ExtraIterator.range.name, () => {
+        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]);
+        });
+        it('should iterate over ranges with steps', () => {
+            expect(ExtraIterator.range(1, 10, { step: 2 }).toArray()).toEqual([1, 3, 5, 7, 9]);
+            expect(ExtraIterator.range(0, 1, { step: 0.25 }).toArray()).toEqual([0, 0.25, 0.5, 0.75]);
+            expect(ExtraIterator.range(10, 0, { step: 2 }).toArray()).toEqual([10, 8, 6, 4, 2]);
+            expect(ExtraIterator.range(10, 0, { step: -2 }).toArray()).toEqual([10, 8, 6, 4, 2]);
+        });
+        it('should iterate over inclusive ranges', () => {
+            expect(ExtraIterator.range(1, 10, { inclusive: true }).toArray()).toEqual([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
+            expect(ExtraIterator.range(1, 10, { inclusive: true, step: 2 }).toArray()).toEqual([1, 3, 5, 7, 9]);
+            expect(ExtraIterator.range(0, 1, { inclusive: true, step: 0.25 }).toArray()).toEqual([0, 0.25, 0.5, 0.75, 1]);
+            expect(ExtraIterator.range(10, 0, { inclusive: true, step: -2 }).toArray()).toEqual([10, 8, 6, 4, 2, 0]);
+        });
+        it('should throw an error if the step is 0', () => {
+            expect(() => ExtraIterator.range(0, 10, { step: 0 }).toArray()).toThrow();
+        });
     });
 });

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