create.increments | /mod.ts | iter@v3.2.3

function create.increments

import { create } from "https://deno.land/x/iter@v3.2.3/mod.ts";
const { increments } = create;

increments(initial?, step?): IterableCircular<number>

Creates an endless iterable of incrementing numbers.

Examples

Example 1

import * as iter from "https://deno.land/x/iter/mod.ts";

const naturals = iter.create.increments(1);
const naturalsIterator = numbers[Symbol.iterator]();

console.log(naturalsIterator.next().value); // -> 1
console.log(naturalsIterator.next().value); // -> 2
console.log(naturalsIterator.next().value); // -> 3
console.log(naturalsIterator.next().value); // -> 4
console.log(naturalsIterator.next().value); // -> 5
console.log(naturalsIterator.next().value); // -> 6

const odds = iter.create.increments(1, 2);
const oddsIterator = odds[Symbol.iterator]();

console.log(oddsIterator.next().value); // -> 1
console.log(oddsIterator.next().value); // -> 3
console.log(oddsIterator.next().value); // -> 5
console.log(oddsIterator.next().value); // -> 7
console.log(oddsIterator.next().value); // -> 9
console.log(oddsIterator.next().value); // -> 11

Parameters

optional

initial = [UNSUPPORTED]

The initial value.

optional

step = [UNSUPPORTED]

The increment amount.

Returns

IterableCircular<number>

An endless iterable of incrementing numbers.