range-pie 2.0.0 → 2.0.1

package/examples/advanced-usage.js

@@ -0,0 +1,61 @@
+/**
+ * Advanced usage examples for range-pie
+ * 
+ * This file demonstrates more advanced features of the PyRange class
+ */
+
+const { PyRange } = require('range-pie');
+
+console.log('\n--- Advanced PyRange Examples ---');
+
+// Example 1: Using the reverse method
+const range1 = new PyRange(1, 6);
+console.log('Original range:', [...range1]);  // [1, 2, 3, 4, 5]
+
+const reversed = range1.reverse();
+console.log('Reversed range:', [...reversed]);  // [5, 4, 3, 2, 1]
+
+// Example 2: Using the asProxy method for array-like access
+const range2 = new PyRange(10).asProxy();
+console.log('range2[0]:', range2[0]);  // 0
+console.log('range2[5]:', range2[5]);  // 5
+
+// Create an array using proxy access
+const firstThree = [range2[0], range2[1], range2[2]];
+console.log('firstThree:', firstThree);  // [0, 1, 2]
+
+// Example 3: Method chaining
+const range3 = new PyRange(1, 10);
+const result = range3
+  .filter(x => x % 2 === 0)  // Get even numbers
+  .map(x => x * x)           // Square them
+  .filter(x => x > 10);      // Filter values greater than 10
+
+console.log('Chained methods result:', result);  // [16, 36, 64]
+
+// Example 4: Using PyRange with other array methods
+const range4 = new PyRange(5);
+const array = [...range4];  // Convert to array: [0, 1, 2, 3, 4]
+
+// Now we can use native array methods
+const sorted = array.sort((a, b) => b - a);  // Sort in descending order
+console.log('Sorted array:', sorted);  // [4, 3, 2, 1, 0]
+
+// Example 5: Creating a range with custom step
+const range5 = new PyRange(0, 11, 2);
+console.log('Range with step 2:', [...range5]);  // [0, 2, 4, 6, 8, 10]
+
+// Example 6: Combining multiple ranges
+const range6a = new PyRange(0, 3);
+const range6b = new PyRange(5, 8);
+const combined = [...range6a, ...range6b];
+console.log('Combined ranges:', combined);  // [0, 1, 2, 5, 6, 7]
+
+// Example 7: Using PyRange for iteration
+console.log('\nIteration example:');
+for (const num of new PyRange(3)) {
+  console.log(`Current number: ${num}`);
+}
+// Current number: 0
+// Current number: 1
+// Current number: 2

package/examples/array-methods.js

@@ -0,0 +1,68 @@
+/**
+ * Array method examples for range-pie
+ * 
+ * This file demonstrates how to use the array-like methods provided by PyRange
+ */
+
+const { PyRange } = require('range-pie');
+
+console.log('\n--- Array Method Examples ---');
+
+// Create a range to work with
+const range = new PyRange(1, 10);
+console.log('Original range:', [...range]);  // [1, 2, 3, 4, 5, 6, 7, 8, 9]
+
+// Map: Double each value
+const doubled = range.map(x => x * 2);
+console.log('map(x => x * 2):', doubled);  // [2, 4, 6, 8, 10, 12, 14, 16, 18]
+
+// Filter: Get only even numbers
+const evens = range.filter(x => x % 2 === 0);
+console.log('filter(x => x % 2 === 0):', evens);  // [2, 4, 6, 8]
+
+// Reduce: Sum all values
+const sum = range.reduce((acc, curr) => acc + curr, 0);
+console.log('reduce((acc, curr) => acc + curr, 0):', sum);  // 45
+
+// Some: Check if any value meets a condition
+const hasEven = range.some(x => x % 2 === 0);
+console.log('some(x => x % 2 === 0):', hasEven);  // true
+
+// Every: Check if all values meet a condition
+const allPositive = range.every(x => x > 0);
+console.log('every(x => x > 0):', allPositive);  // true
+
+// Find: Get the first value that meets a condition
+const firstEven = range.find(x => x % 2 === 0);
+console.log('find(x => x % 2 === 0):', firstEven);  // 2
+
+// FindIndex: Get the index of the first value that meets a condition
+const firstEvenIndex = range.findIndex(x => x % 2 === 0);
+console.log('findIndex(x => x % 2 === 0):', firstEvenIndex);  // 1
+
+// FindLastIndex: Get the index of the last value that meets a condition
+const lastEvenIndex = range.findLastIndex(x => x % 2 === 0);
+console.log('findLastIndex(x => x % 2 === 0):', lastEvenIndex);  // 7
+
+// Includes: Check if a value exists in the range
+const includesFive = range.includes(5);
+console.log('includes(5):', includesFive);  // true
+
+// IndexOf: Get the index of a value
+const indexOfFive = range.indexOf(5);
+console.log('indexOf(5):', indexOfFive);  // 4
+
+// LastIndexOf: Get the last index of a value
+const lastIndexOfFive = range.lastIndexOf(5);
+console.log('lastIndexOf(5):', lastIndexOfFive);  // 4
+
+// ForEach: Execute a function for each value
+console.log('\nforEach example:');
+range.forEach(x => {
+  if (x % 3 === 0) {
+    console.log(`${x} is divisible by 3`);
+  }
+});
+// 3 is divisible by 3
+// 6 is divisible by 3
+// 9 is divisible by 3

package/examples/basic-usage.js

@@ -0,0 +1,42 @@
+/**
+ * Basic usage examples for range-pie
+ * 
+ * This file demonstrates the fundamental ways to use the PyRange class
+ * with JavaScript.
+ */
+
+// CommonJS import
+const { PyRange } = require('range-pie');
+
+console.log('\n--- Basic PyRange Examples ---');
+
+// Example 1: Simple range with just stop value
+const range1 = new PyRange(5);
+console.log('PyRange(5):', [...range1]);  // [0, 1, 2, 3, 4]
+
+// Example 2: Range with start and stop
+const range2 = new PyRange(2, 8);
+console.log('PyRange(2, 8):', [...range2]);  // [2, 3, 4, 5, 6, 7]
+
+// Example 3: Range with start, stop, and step
+const range3 = new PyRange(1, 10, 2);
+console.log('PyRange(1, 10, 2):', [...range3]);  // [1, 3, 5, 7, 9]
+
+// Example 4: Negative step
+const range4 = new PyRange(10, 0, -2);
+console.log('PyRange(10, 0, -2):', [...range4]);  // [10, 8, 6, 4, 2]
+
+console.log('\n--- Accessing Properties ---');
+console.log('range3.start:', range3.start);  // 1
+console.log('range3.stop:', range3.stop);    // 10
+console.log('range3.step:', range3.step);    // 2
+console.log('range3.length:', range3.length);  // 5
+
+console.log('\n--- Using at() Method ---');
+console.log('range3.at(0):', range3.at(0));  // 1
+console.log('range3.at(2):', range3.at(2));  // 5
+// console.log(range3.at(10));  // Would throw RangeError: Index out of range
+
+console.log('\n--- Converting to Array ---');
+const array = range3.toArray();
+console.log('range3.toArray():', array);  // [1, 3, 5, 7, 9]

package/examples/typescript-usage.ts

@@ -0,0 +1,61 @@
+/**
+ * TypeScript usage examples for range-pie
+ *
+ * This file demonstrates how to use the PyRange class with TypeScript,
+ * taking advantage of type safety and generics.
+ */
+
+// ES Module import
+import { PyRange } from "range-pie";
+
+console.log("\n--- TypeScript PyRange Examples ---");
+
+// Basic usage is the same as JavaScript
+const range = new PyRange(1, 10);
+console.log("Basic range:", [...range]); // [1, 2, 3, 4, 5, 6, 7, 8, 9]
+
+// TypeScript provides type safety
+// This would cause a compile-time error:
+// const badRange = new PyRange("not a number");
+
+// Type inference with generics
+// TypeScript knows this returns number[]
+const numbers = range.map((x) => x * 2);
+console.log("Doubled numbers:", numbers); // [2, 4, 6, 8, 10, 12, 14, 16, 18]
+
+// TypeScript knows this returns string[]
+const strings = range.map((x) => `Number: ${x}`);
+console.log("First string:", strings[0]); // "Number: 1"
+
+// TypeScript knows this returns boolean[]
+const booleans = range.map((x) => x % 2 === 0);
+console.log("Is even:", booleans); // [false, true, false, true, false, true, false, true, false]
+
+// Type safety with callbacks
+range.forEach((value: number, index: number) => {
+  console.log(`Value at index ${index}: ${value}`);
+});
+
+// Using reduce with proper typing
+const sum: number = range.reduce((acc, curr) => acc + curr, 0);
+console.log("Sum:", sum); // 45
+
+// Creating a custom object with map
+interface NumberInfo {
+  value: number;
+  isEven: boolean;
+  square: number;
+}
+
+const infoArray: NumberInfo[] = range.map((x) => ({
+  value: x,
+  isEven: x % 2 === 0,
+  square: x * x,
+}));
+
+console.log("First object:", infoArray[0]); // { value: 1, isEven: false, square: 1 }
+
+// Chaining methods with type safety
+const evenSquares: number[] = range.filter((x) => x % 2 === 0).map((x) => x * x);
+
+console.log("Even squares:", evenSquares); // [4, 16, 36, 64]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "range-pie",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "A TypeScript class that simulates Python's range function, combined with several useful JavaScript array methods.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,7 +12,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "examples"
   ],
   "scripts": {
     "build": "tsc",
@@ -41,7 +42,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/SkorpionG/range-pie.git"
+    "url": "git+https://github.com/SkorpionG/range-pie.git"
   },
   "devDependencies": {
     "@types/jest": "^29.5.0",