@codibre/fluent-iterable/dist/interval.d.ts

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

import { FluentIterable } from './types';
/**
 * 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.
 */
export declare function interval(fromInclusive?: number, count?: number): FluentIterable<number>;
/**
 * Generates a `count` long sequential integer interval starting from `fromInclusive`.
 *
 * * The interval ends in negative infinity if `count` is not specified.
 *
 * Examples:
 *
 * 1. `decrement(5, 3)` generates an interval of `[5, 4, 3]`
 * 2. `decrement(5)` generates an interval of `[5, 4, 3, ...]`
 * 3. `decrement()` generates an interval of `[0, -1, -2, ...]`
 * 4. `decrement(1).take(10).forEach(console.log)` prints all numbers between 1 and -9.
 * @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.
 */
export declare function decrement(fromInclusive?: number, count?: number): FluentIterable<number>;