| 1 | /**
|
| 2 | * Enumerate an iterable object.
|
| 3 | *
|
| 4 | * @param object - The iterable object of interest.
|
| 5 | *
|
| 6 | * @param start - The starting enum value. The default is `0`.
|
| 7 | *
|
| 8 | * @returns An iterator which yields the enumerated values.
|
| 9 | *
|
| 10 | * #### Example
|
| 11 | * ```typescript
|
| 12 | * import { enumerate } from '@lumino/algorithm';
|
| 13 | *
|
| 14 | * let data = ['foo', 'bar', 'baz'];
|
| 15 | *
|
| 16 | * let stream = enumerate(data, 1);
|
| 17 | *
|
| 18 | * Array.from(stream); // [[1, 'foo'], [2, 'bar'], [3, 'baz']]
|
| 19 | * ```
|
| 20 | */
|
| 21 | export declare function enumerate<T>(object: Iterable<T>, start?: number): IterableIterator<[number, T]>;
|