get-range

get-range

Lazy number range generator

Useful for iteration.

Similar to the Python 3 range function.

Install

npm install get-range

Usage

import getRange from 'get-range';

for (const index of getRange({end: 4})) {
	console.log(index);
}
//=> 0
//=> 1
//=> 2
//=> 3

const range = getRange({start: 0, end: 4, step: 2});

range.next().value;
//=> 0

range.next().value;
//=> 2

console.log(...getRange({start: 0, end: -5, step: -1}));
//=> [0, -1, -2, -3, -4]

It can replace normal for-loops in many cases:

// Before
for (let i = 0; i < 5; i++) {}

// After
for (const index of getRange({end: 5})) {}

API

getRange(range)

Returns a Generator object (which is both an Iterable and Iterator).

range

Type: object

start

Type: integer
Default: 0

Start of the range.

end

Type: integer

End of the range.

step

Type: integer
Default: 1
Minimum: 1

Distance between numbers.

inclusive

Type: boolean
Default: false

Whether or not to include the end value in the range.

import getRange from 'get-range';

console.log(...getRange({start: 3, end: 5, inclusive: true}));
//=> [3, 4, 5]