Range Iterator (TypeScript)

⚖️ MIT

🗂️

🆙 Latest Release Version ( Latest Release Date )

A TypeScript module to iterate between range.

🎯 Target

Bun ^ v1.0.0
Cloudflare Workers
Deno >= v1.34.0 / >= v1.41.1 (Via JSR)

🛡️ Require Permission

N/A
NodeJS >= v16.13.0

🔗 Other Edition

JavaScript

🔰 Usage

Via HTTPS

🎯 Supported Target

Deno

Import at the script (<ScriptName>.ts):
- Via Deno Land
```
import ... from "https://deno.land/x/range_iterator[@<Tag>]/mod.ts";
```
- Via DenoPKG
```
import ... from "https://denopkg.com/hugoalh-studio/range-iterator-ts[@<Tag>]/mod.ts";
```
- Via DenoPKG (Legacy)
```
import ... from "https://denopkg.com/hugoalh-studio/range-iterator-deno[@<Tag>]/mod.ts";
```
- Via GitHub Raw (Require Tag)
```
import ... from "https://raw.githubusercontent.com/hugoalh-studio/range-iterator-ts/<Tag>/mod.ts";
```
- Via GitHub Raw (Legacy)(Require Tag)
```
import ... from "https://raw.githubusercontent.com/hugoalh-studio/range-iterator-deno/<Tag>/mod.ts";
```
- Via Pax
```
import ... from "https://pax.deno.dev/hugoalh-studio/range-iterator-ts[@<Tag>]/mod.ts";
```
- Via Pax (Legacy)
```
import ... from "https://pax.deno.dev/hugoalh-studio/range-iterator-deno[@<Tag>]/mod.ts";
```
ℹ️ Note

Although it is recommended to import the entire module with the main path mod.ts, it is also able to import part of the module with sub path if available, but do not import if:
- it’s file path has an underscore prefix (e.g.: _foo.ts, _util/bar.ts), or
- it is a benchmark or test file (e.g.: foo.bench.ts, foo.test.ts), or
- it’s symbol has an underscore prefix (e.g.: export function _baz() {}).
These elements are not considered part of the public API, thus no stability is guaranteed for them.

Via JSR With Native Support

🎯 Supported Target

Deno

Import at the script (<ScriptName>.ts):
```
import ... from "jsr:@hugoalh/range-iterator[@<Tag>]";
```
ℹ️ Note

Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit file jsr.jsonc property exports for available sub paths.

Via JSR With NPM Compatibility Layer Support

🎯 Supported Target

Bun

Cloudflare Workers

NodeJS

Install via console/shell/terminal:

Via Bun

bunx jsr add @hugoalh/range-iterator[@<Tag>]

Via NPM

npx jsr add @hugoalh/range-iterator[@<Tag>]

Via PNPM

pnpm dlx jsr add @hugoalh/range-iterator[@<Tag>]

Via Yarn

yarn dlx jsr add @hugoalh/range-iterator[@<Tag>]

Import at the script (<ScriptName>.ts):
```
import ... from "@hugoalh/range-iterator";
```
ℹ️ Note

Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit file jsr.jsonc property exports for available sub paths.

🧩 API

function rangeIterator(start: bigint, end: bigint, step?: RangeIteratorOptions<bigint>["step"]): Generator<bigint>;
function rangeIterator(start: number, end: number, step?: RangeIteratorOptions<number>["step"]): Generator<number>;
function rangeIterator(start: string, end: string, step?: RangeIteratorOptions<string>["step"]): Generator<string>;
function rangeIterator(start: bigint, end: bigint, options?: RangeIteratorOptions<bigint>): Generator<bigint>;
function rangeIterator(start: number, end: number, options?: RangeIteratorOptions<number>): Generator<number>;
function rangeIterator(start: string, end: string, options?: RangeIteratorOptions<string>): Generator<string>;

interface RangeIteratorOptions<T extends RangeIteratorAcceptType> {
  /**
  * Whether to exclusive end.
  * @default false
  */
  endExclusive?: boolean;
  /**
  * Step of the decrement/increment of the iterate.
  * @default 1n // Big integer.
  * @default 1 // Number/String.
  */
  step?: RangeIteratorIndexType<T>;
}

type RangeIteratorAcceptType = bigint | number | string;

type RangeIteratorIndexType<T extends RangeIteratorAcceptType> = T extends bigint ? bigint : number;

ℹ️ Note

For the prettier documentation, can visit via:

Deno CLI deno doc

JSR

✍️ Example

Array.from(rangeIterator(1, 9));
//=> [1, 2, 3, 4, 5, 6, 7, 8, 9]

Array.from(rangeIterator(1n, 9n, { endExclusive: true }));
//=> [1n, 2n, 3n, 4n, 5n, 6n, 7n, 8n]

Array.from(rangeIterator(1, 9, { step: 0.5 }));
//=> [1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5, 5.5, 6, 6.5, 7, 7.5, 8, 8.5, 9]

Array.from(rangeIterator("a", "z"));
//=> ["a", "b", "c", ... +20 ..., "x", "y", "z"]

Array.from(rangeIterator(9, 1));
//=> [9, 8, 7, 6, 5, 4, 3, 2, 1]

Array.from(rangeIterator(9n, 1n, { endExclusive: true }));
//=> [9n, 8n, 7n, 6n, 5n, 4n, 3n, 2n]

Array.from(rangeIterator(9, 1, { step: 0.5 }));
//=> [9, 8.5, 8, 7.5, 7, 6.5, 6, 5.5, 5, 4.5, 4, 3.5, 3, 2.5, 2, 1.5, 1]

Array.from(rangeIterator("z", "a"));
//=> ["z", "y", "x", ... +20 ..., "c", "b", "a"]