range-pie 1.0.1 → 2.0.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 SkorpionG2000
+Copyright (c) 2025 SkorpionG2000
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,11 +1,15 @@
 # range-pie
 
-A JavaScript library that brings Python's range functionality to JavaScript, enhanced with familiar array methods. This lightweight utility provides a seamless way to work with numeric sequences while maintaining JavaScript's functional programming paradigm.
+A TypeScript/JavaScript library that brings Python's range functionality to JavaScript, enhanced with familiar array methods. This lightweight utility provides a seamless way to work with numeric sequences while maintaining JavaScript's functional programming paradigm. Fully typed for TypeScript users while remaining compatible with JavaScript projects.
 
 ## Table of Contents
 
 - [Installation](#installation)
 - [Basic Usage](#basic-usage)
+
+  - [JavaScript](#javascript)
+  - [TypeScript](#typescript)
+
 - [API Reference](#api-reference)
 
   - [Constructor Options](#constructor-options)
@@ -36,6 +40,9 @@ A JavaScript library that brings Python's range functionality to JavaScript, enh
 
   - [Methods chaining](#methods-chaining)
   - [Using as Array-like Object](#using-as-array-like-object)
+  - [Example Files](#example-files)
+    - [Running the Examples](#running-the-examples)
+    - [Available Examples](#available-examples)
 
 ## Installation
 
@@ -45,7 +52,10 @@ npm install range-pie
 
 ## Basic Usage
 
+### JavaScript
+
 ```javascript
+// CommonJS
 const { PyRange } = require('range-pie');
 
 // Create a range from 0 to 5
@@ -61,6 +71,25 @@ const range3 = new PyRange(0, 10, 2);
 console.log([...range3]); // [0, 2, 4, 6, 8]
 ```
 
+### TypeScript
+
+```typescript
+// ES Modules
+import { PyRange } from 'range-pie';
+
+// Create a range from 0 to 5
+const range = new PyRange(5);
+console.log([...range]); // [0, 1, 2, 3, 4]
+
+// Type-safe operations
+const doubledValues: number[] = range.map(x => x * 2);
+console.log(doubledValues); // [0, 2, 4, 6, 8]
+
+// Type inference works with generics
+const stringValues: string[] = range.map(x => `Value: ${x}`);
+console.log(stringValues); // ['Value: 0', 'Value: 1', 'Value: 2', 'Value: 3', 'Value: 4']
+```
+
 ## API Reference
 
 ### Constructor Options
@@ -304,6 +333,29 @@ console.log(proxy[0]); // 0
 console.log(proxy[3]); // 3
 ```
 
+### TypeScript Support
+
+This package is written in TypeScript and provides full type definitions for all methods and properties. TypeScript users get the following benefits:
+
+- Type checking for all method parameters and return values
+- Autocompletion in IDEs
+- Generic type support for methods like `map()` and `reduce()`
+- Better documentation through type annotations
+
+```typescript
+// Type inference with generics
+const range = new PyRange(5);
+
+// TypeScript knows this is a number[]
+const numbers = range.map(x => x * 2);
+
+// TypeScript knows this is a string[]
+const strings = range.map(x => `Number: ${x}`);
+
+// TypeScript knows this is a boolean[]
+const booleans = range.map(x => x % 2 === 0);
+```
+
 ## Examples
 
 ### Methods chaining
@@ -323,3 +375,43 @@ const range = new PyRange(5).asProxy();
 const firstThree = [range[0], range[1], range[2]];
 console.log(firstThree); // [0, 1, 2]
 ```
+
+### Example Files
+
+This package includes several example files to help you get started. You can find them in the `examples` directory after installing the package.
+
+#### Running the Examples
+
+If you've cloned the repository, you can run the examples using npm scripts:
+
+```bash
+# Run basic usage examples
+npm run example:basic
+
+# Run array methods examples
+npm run example:array
+
+# Run advanced usage examples
+npm run example:advanced
+
+# Run TypeScript examples (requires ts-node)
+npm run example:ts
+```
+
+Or you can run them directly with Node.js:
+
+```bash
+node node_modules/range-pie/examples/basic-usage.js
+node node_modules/range-pie/examples/array-methods.js
+node node_modules/range-pie/examples/advanced-usage.js
+
+# For TypeScript examples
+ts-node node_modules/range-pie/examples/typescript-usage.ts
+```
+
+#### Available Examples
+
+- **basic-usage.js**: Shows fundamental PyRange operations
+- **array-methods.js**: Demonstrates all array-like methods
+- **advanced-usage.js**: Covers advanced features like method chaining and proxy usage
+- **typescript-usage.ts**: Shows TypeScript-specific features and type safety

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import PyRange, { PyRange as PyRangeClass } from "./py-range";
+export { PyRangeClass as PyRange };
+export default PyRange;

package/dist/index.js

@@ -0,0 +1,40 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PyRange = void 0;
+const py_range_1 = __importStar(require("./py-range"));
+Object.defineProperty(exports, "PyRange", { enumerable: true, get: function () { return py_range_1.PyRange; } });
+exports.default = py_range_1.default;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uDAA8D;AAGrC,wFAHI,kBAAY,OAGT;AAChC,kBAAe,kBAAO,CAAC"}

package/dist/py-range.d.ts

@@ -0,0 +1,185 @@
+/**
+ * A class that simulates Python's range function, combined with several useful JavaScript array methods.
+ */
+declare class PyRange implements Iterable<number> {
+    private _start;
+    private _stop;
+    private _step;
+    private _length;
+    /**
+     * Creates a new PyRange instance.
+     * @param {...number} args - The arguments of the range. The possible forms are
+     *   - `PyRange(stop)`
+     *   - `PyRange(start, stop)`
+     *   - `PyRange(start, stop, step)`
+     * @throws {TypeError} If any of the arguments is not a number.
+     * @throws {TypeError} If any of the arguments is not an integer.
+     * @throws {Error} If the step is zero.
+     * @throws {Error} If the arguments count is not between 1 and 3.
+     * @property {number} start - The start of the range, inclusive.
+     * @property {number} stop - The stop of the range, exclusive.
+     * @property {number} step - The step of the range.
+     * @property {number} length - The length of the range.
+     */
+    constructor(...args: number[]);
+    /**
+     * Gets the length of this range.
+     *
+     * @returns {number} the length of this range
+     * @readonly
+     */
+    get length(): number;
+    /**
+     * Gets the starting value of the range.
+     *
+     * @returns {number} The starting value of the range.
+     * @readonly
+     */
+    get start(): number;
+    /**
+     * Gets the ending value of the range.
+     *
+     * @returns {number} The ending value of the range.
+     * @readonly
+     */
+    get stop(): number;
+    /**
+     * Gets the step value of the range.
+     *
+     * @returns {number} The step value of the range.
+     * @readonly
+     */
+    get step(): number;
+    /**
+     * Gets the value at the specified index in this range.
+     * @param {number} index - The index of the value to retrieve
+     * @returns {number} The value at the specified index
+     * @throws {RangeError} If the index is out of range
+     */
+    at(index: number): number;
+    /**
+     * Converts the range to a string.
+     * @returns {string} A string of the form `Range(start, stop, step)`.
+     */
+    toString(): string;
+    /**
+     * Converts the range to an array.
+     * @returns {number[]} An array of numbers with the same elements as this range.
+     */
+    toArray(): number[];
+    /**
+     * Validates that the callback is a function.
+     * @param {Function} cb - The callback to validate.
+     * @throws {TypeError} If the callback is not a function.
+     */
+    private static validateCb;
+    /**
+     * Creates a new array with the results of applying the given callback
+     * function to every element in this range.
+     * @param {function(number, number, PyRange): T} callback - The callback
+     * function to apply to every element.
+     * @returns {T[]} A new array of the same length as this range.
+     * @template T
+     */
+    map<T>(callback: (value: number, index: number, range: PyRange) => T): T[];
+    /**
+     * Creates a new array with all elements that pass the test implemented by
+     * the provided function.
+     * @param {function(number, number, PyRange): boolean} callback - The
+     * predicate function to apply to every element
+     * @returns {number[]} A new array of elements that pass the test
+     */
+    filter(callback: (value: number, index: number, range: PyRange) => boolean): number[];
+    /**
+     * Reduces the range to a single value.
+     * @param {function(T, number, number, PyRange): T} callback - The callback
+     * function to apply to every element. The callback should take four
+     * arguments: the accumulator, the current value, the index of the current
+     * value, and the range object.
+     * @param {T} [initialValue] - The initial value of the accumulator.
+     * @returns {T} The final value of the accumulator.
+     * @template T
+     */
+    reduce<T>(callback: (accumulator: T, value: number, index: number, range: PyRange) => T, initialValue?: T): T;
+    /**
+     * Determines whether at least one element of the range satisfies the
+     * provided test.
+     * @param {function(number, number, PyRange): boolean} callback - The
+     * predicate function to apply to every element
+     * @returns {boolean} True if at least one element of the range passes the
+     * test, false otherwise.
+     */
+    some(callback: (value: number, index: number, range: PyRange) => boolean): boolean;
+    /**
+     * Determines whether all elements of the range satisfy the provided test.
+     * @param {function(number, number, PyRange): boolean} callback - The
+     * predicate function to apply to every element
+     * @returns {boolean} True if all elements of the range pass the test,
+     * false otherwise.
+     */
+    every(callback: (value: number, index: number, range: PyRange) => boolean): boolean;
+    /**
+     * Finds the first element in this range that satisfies the provided test.
+     * @param {function(number, number, PyRange): boolean} callback - The
+     * predicate function to apply to every element
+     * @returns {number|undefined} The first element that passes the test,
+     * or undefined if no element passes the test.
+     */
+    find(callback: (value: number, index: number, range: PyRange) => boolean): number | undefined;
+    /**
+     * Finds the index of the first element in this range that satisfies the provided test.
+     * @param {function(number, number, PyRange): boolean} callback - The predicate function to apply to each element.
+     * @returns {number} The index of the first element that passes the test, or -1 if no element passes the test.
+     */
+    findIndex(callback: (value: number, index: number, range: PyRange) => boolean): number;
+    /**
+     * Finds the index of the last element in this range that satisfies the provided test.
+     * @param {function(number, number, PyRange): boolean} callback - The predicate function to apply to each element.
+     * @returns {number} The index of the last element that passes the test, or -1 if no element passes the test.
+     */
+    findLastIndex(callback: (value: number, index: number, range: PyRange) => boolean): number;
+    /**
+     * Executes a provided function once for each element in this range.
+     * @param {function(number, number, PyRange): void} callback - The
+     * function to execute for each element.
+     */
+    forEach(callback: (value: number, index: number, range: PyRange) => void): void;
+    /**
+     * Determines whether the given value is present in this range.
+     * @param {any} value - The value to search for.
+     * @returns {boolean} True if the value is present, false otherwise.
+     */
+    includes(value: any): boolean;
+    /**
+     * Returns the index of the first occurrence of the specified value, or -1 if it is not present.
+     * @param {any} value - The value to search for.
+     * @returns {number} The index of the value, or -1 if it is not present.
+     */
+    indexOf(value: any): number;
+    /**
+     * Returns the index of the last occurrence of the specified value, or -1 if it is not present.
+     * @param {any} value - The value to search for.
+     * @returns {number} The index of the last occurrence of the value, or -1 if it is not present.
+     */
+    lastIndexOf(value: any): number;
+    /**
+     * Reverses the order of the elements in this range, returning a new PyRange object.
+     * @returns {PyRange} A new PyRange object with the elements in reverse order.
+     */
+    reverse(): PyRange;
+    /**
+     * Implements the iterable protocol for this range.
+     * @returns {Iterator<number>} An iterator for this range.
+     */
+    [Symbol.iterator](): Iterator<number>;
+    /**
+     * Returns a Proxy for this range, allowing indexed access.
+     * This proxy enables accessing range elements via array-like indexing.
+     * If the property is a number, it will return the element at that index.
+     *
+     * @returns {any} A proxy for the PyRange instance.
+     */
+    asProxy(): any;
+}
+export { PyRange };
+export default PyRange;