range-pie 2.3.0 → 2.4.0

package/README.md

@@ -32,6 +32,9 @@ A TypeScript/JavaScript library that brings Python's range functionality to Java
   - [pop()](#pop)
   - [slice()](#slice)
   - [reverse()](#reverse)
+  - [entries()](#entries)
+  - [keys()](#keys)
+  - [values()](#values)
 
 - [Advanced Usage](#advanced-usage)
 
@@ -74,6 +77,10 @@ console.log([...range2]); // [2, 3, 4, 5, 6, 7]
 // Create a range with step
 const range3 = new PyRange(0, 10, 2);
 console.log([...range3]); // [0, 2, 4, 6, 8]
+
+// Create a reverse range
+const range4 = new PyRange(5, 2);
+console.log([...range4]); // [5, 4, 3]
 ```
 
 ### TypeScript
@@ -341,6 +348,41 @@ const reversedStep = rangeWithStep.reverse(); // [9, 7, 5, 3, 1]
 console.log([...reversedStep]);
 ```
 
+### entries()
+
+It works the same as [**`Array.prototype.entries`**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/entries).
+It returns an iterator of `[index, value]` pairs.
+
+```javascript
+const range = new PyRange(1, 4);  // [1, 2, 3]
+for (const [index, value] of range.entries()) {
+  console.log(index, value);
+}
+// 0 1
+// 1 2
+// 2 3
+```
+
+### keys()
+
+It works the same as [**`Array.prototype.keys`**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/keys).
+It returns an iterator of the indices of the range.
+
+```javascript
+const range = new PyRange(3);  // [0, 1, 2]
+console.log([...range.keys()]); // [0, 1, 2]
+```
+
+### values()
+
+It works the same as [**`Array.prototype.values`**](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values).
+It returns an iterator of the values in the range.
+
+```javascript
+const range = new PyRange(3);  // [0, 1, 2]
+console.log([...range.values()]); // [0, 1, 2]
+```
+
 ## Advanced Usage
 
 ### Iteration

package/dist/py-range.d.ts

@@ -192,6 +192,31 @@ declare class PyRange implements Iterable<number> {
      * @returns {PyRange} A new PyRange object with the elements in reverse order.
      */
     reverse(): PyRange;
+    /**
+     * Returns an iterator of `[index, value]` pairs for each element in the range.
+     *
+     * This method behaves like `Array.prototype.entries()` and is useful for
+     * iterating over both the index and value of each item.
+     *
+     * @returns {IterableIterator<[number, number]>} Iterator of index/value pairs.
+     */
+    entries(): IterableIterator<[number, number]>;
+    /**
+     * Returns an iterator of the indices for each element in the range.
+     *
+     * Works the same as `Array.prototype.keys()`.
+     *
+     * @returns {IterableIterator<number>} Iterator of indices.
+     */
+    keys(): IterableIterator<number>;
+    /**
+     * Returns an iterator of the values in the range.
+     *
+     * Equivalent to `Array.prototype.values()`.
+     *
+     * @returns {IterableIterator<number>} Iterator of values.
+     */
+    values(): IterableIterator<number>;
     /**
      * Implements the iterable protocol for this range.
      * @returns {Iterator<number>} An iterator for this range.

package/dist/py-range.js

@@ -381,6 +381,41 @@ class PyRange {
         result._length = this._length;
         return result;
     }
+    /**
+     * Returns an iterator of `[index, value]` pairs for each element in the range.
+     *
+     * This method behaves like `Array.prototype.entries()` and is useful for
+     * iterating over both the index and value of each item.
+     *
+     * @returns {IterableIterator<[number, number]>} Iterator of index/value pairs.
+     */
+    *entries() {
+        for (let i = 0; i < this._length; i++) {
+            yield [i, this.at(i)];
+        }
+    }
+    /**
+     * Returns an iterator of the indices for each element in the range.
+     *
+     * Works the same as `Array.prototype.keys()`.
+     *
+     * @returns {IterableIterator<number>} Iterator of indices.
+     */
+    *keys() {
+        for (let i = 0; i < this._length; i++) {
+            yield i;
+        }
+    }
+    /**
+     * Returns an iterator of the values in the range.
+     *
+     * Equivalent to `Array.prototype.values()`.
+     *
+     * @returns {IterableIterator<number>} Iterator of values.
+     */
+    *values() {
+        yield* this;
+    }
     /**
      * Implements the iterable protocol for this range.
      * @returns {Iterator<number>} An iterator for this range.

package/examples/array-methods.js

@@ -76,3 +76,15 @@ console.log("After pop:", [...range]); // [1, 2, 3, 4, 5, 6, 7, 8]
 const sliced = range.slice(2, 5);
 console.log("slice(2, 5):", [...sliced]); // [3, 4, 5]
 console.log("Original after slice:", [...range]); // [1, 2, 3, 4, 5, 6, 7, 8] (unchanged)
+
+// Entries: Iterate over index/value pairs
+console.log("\nentries() example:");
+for (const [i, v] of range.entries()) {
+  if (i < 3) {
+    console.log(i, v);
+  }
+}
+
+// Keys and values helpers
+console.log("keys():", [...range.keys()].slice(0, 3)); // [0,1,2]
+console.log("values():", [...range.values()].slice(0, 3)); // [1,2,3]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "range-pie",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "A TypeScript class that simulates Python's range function, combined with several useful JavaScript array methods.",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -36,7 +36,8 @@
     "example:array": "node examples/array-methods.js",
     "example:advanced": "node examples/advanced-usage.js",
     "example:ts": "ts-node examples/typescript-usage.ts",
-    "example:methods": "for file in examples/methods/*.ts; do echo \"\\n=== Running $file ===\"; ts-node \"$file\"; done"
+    "example:methods": "for file in examples/methods/*.ts; do echo \"\\n=== Running $file ===\"; ts-node \"$file\"; done",
+    "knip": "knip"
   },
   "keywords": [
     "range",
@@ -58,14 +59,16 @@
   "devDependencies": {
     "@eslint/js": "^9.28.0",
     "@types/jest": "^29.5.0",
+    "@types/node": "^24.0.3",
     "eslint": "^9.28.0",
     "globals": "^16.2.0",
     "jest": "^29.7.0",
+    "knip": "^5.61.2",
     "prettier": "^3.5.3",
     "rimraf": "^5.0.0",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.4",
+    "typescript": "^5.8.3",
     "typescript-eslint": "^8.33.1"
   }
 }