UNPKG

767 BTypeScriptView Raw
1/**
2 * Create an iterator of evenly spaced values.
3 *
4 * @param start - The starting value for the range, inclusive.
5 *
6 * @param stop - The stopping value for the range, exclusive.
7 *
8 * @param step - The distance between each value.
9 *
10 * @returns An iterator which produces evenly spaced values.
11 *
12 * #### Notes
13 * In the single argument form of `range(stop)`, `start` defaults to
14 * `0` and `step` defaults to `1`.
15 *
16 * In the two argument form of `range(start, stop)`, `step` defaults
17 * to `1`.
18 *
19 * #### Example
20 * ```typescript
21 * import { range } from '@lumino/algorithm';
22 *
23 * let stream = range(2, 4);
24 *
25 * Array.from(stream); // [2, 3]
26 * ```
27 */
28export declare function range(start: number, stop?: number, step?: number): IterableIterator<number>;