Function createRangeIterator

createRangeIterator(start, end, step?): Iterator<number>

Create a simple range iterator which will return an iterator that increments it's value from start to end by the step.

If end is omitted, null or undefined the value will be set to start
If the step value is omitted, null, undefined or zero then it will default to 1 if end > start otherwise -1.

Parameters

start: number
The initial value of the numeric iterator
end: number
The inclusive maximum (or minimum when moving backwards) value of the iterator.
Optionalstep: number
The step size for each iteration, may be positive or negative. Defaults to 1 when start <= end and -1 when start > end. Zero is treated as not provided.

Returns Iterator<number>

A new iterator which will return a numeric value between start and end at step intervals

Since

0.4.2

Example

let cnt = 0;
iterForOf(createRangeIterator(0, -1, 1), (value) => {
    // Will never get called as -1 < 0
});

cnt = 0;
let values: number[] = [];
iterForOf(createRangeIterator(1, 1), (value) => {
    cnt++;
    values.push(value);
});
// cnt === 1
// values: [ 1 ]

cnt = 0;
values = [];
iterForOf(createRangeIterator(10, null as any), (value) => {
    cnt++;
    values.push(value);
});
// cnt === 1
// values: [ 10 ]

cnt = 0;
values = [];
iterForOf(createRangeIterator(-10, undefined as any), (value) => {
    cnt++;
    values.push(value);
});
// cnt === 1
// values: [ -10 ]

cnt = 0;
values = [];
iterForOf(createRangeIterator(5, 20, 5), (value) => {
    cnt++;
    values.push(value);
});
// cnt === 4
// values: [ 5, 10, 15, 20 ]

cnt = 0;
values = [];
iterForOf(createRangeIterator(20, 5, -5), (value) => {
    cnt++;
    values.push(value);
});
// cnt === 4
// values: [ 20, 15, 10, 5 ]

cnt = 0;
values = [];
iterForOf(createRangeIterator(20, 15), (value) => {
    cnt++;
    values.push(value);
});
// cnt === 6
// values: [ 20, 19, 18, 17, 16, 15 ]

cnt = 0;
values = [];
iterForOf(createRangeIterator(-1, 1), (value) => {
    cnt++;
    values.push(value);
});
// cnt === 3;
// values: [ -1, 0, 1 ]

cnt = 0;
values = [];
iterForOf(createRangeIterator(1, -1), (value) => {
    cnt++;
    values.push(value);
});
// cnt === 3;
// values: [ 1, 0, -1 ]