fast-iterable/dist/interval.js

Provides LINQ-like fluent api operations for iterables and async iterables (ES2018+).

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.interval = void 0;
const fluent_1 = require("./fluent");
function internalInterval(fromInclusive, count) {
    const from = fromInclusive || 0;
    let offset = 0;
    return {
        [Symbol.iterator]: () => ({
            next() {
                const done = count !== undefined && offset >= count;
                const value = from + offset;
                offset++;
                return {
                    value,
                    done,
                };
            },
        }),
    };
}
/**
 * Generates a `count` long sequential integer interval starting from `fromInclusive`.
 *
 * * The interval starts at zero if `fromInclusive` is not specified.
 * * The interval ends in infinity if `count` is not specified.
 *
 * Examples:
 *
 * 1. `interval(5, 3)` generates an interval of `[5, 6, 7]`
 * 2. `interval(5)` generates an interval of `[5, 6, 7, ...]`
 * 3. `interval()` generates an interval of `[0, 1, 2, ...]`
 * 4. `fluent(interval(1)).take(10).forEach(console.log)` prints all numbers between 1 and 10 using [[fluent]].
 * @param fromInclusive Specifies the start of the interval. Defaults to zero.
 * @param count Specifies the length of the interval. The interval provides numbers indefinitely if omitted.
 * @returns The iterable of numbers in the interval.
 */
function interval(fromInclusive, count) {
    return (0, fluent_1.default)(internalInterval(fromInclusive, count));
}
exports.interval = interval;