| 1 | /**
|
| 2 | * Iterate several iterables in lockstep.
|
| 3 | *
|
| 4 | * @param objects - The iterable objects of interest.
|
| 5 | *
|
| 6 | * @returns An iterator which yields successive tuples of values where
|
| 7 | * each value is taken in turn from the provided iterables. It will
|
| 8 | * be as long as the shortest provided iterable.
|
| 9 | *
|
| 10 | * #### Example
|
| 11 | * ```typescript
|
| 12 | * import { zip } from '@lumino/algorithm';
|
| 13 | *
|
| 14 | * let data1 = [1, 2, 3];
|
| 15 | * let data2 = [4, 5, 6];
|
| 16 | *
|
| 17 | * let stream = zip(data1, data2);
|
| 18 | *
|
| 19 | * Array.from(stream); // [[1, 4], [2, 5], [3, 6]]
|
| 20 | * ```
|
| 21 | */
|
| 22 | export declare function zip<T>(...objects: Iterable<T>[]): IterableIterator<T[]>;
|