@thi.ng/transducers/zip.d.ts

Collection of ~170 lightweight, composable transducers, reducers, generators, iterators for functional data transformations

/**
 * Accepts a number of iterables and combines them into an iterable of
 * tuples of successively consumed input values.
 *
 * @remarks
 * Tuples are formed by merging each value of each input iterable, such
 * that the first yielded tuple contains the first elements of the given
 * inputs, the second tuple contains the second elements of the inputs,
 * etc.
 *
 * The number of resulting tuples will be the same as the length of the
 * shortest input iterable. Given only a single argument, `zip` yields a
 * sequence of 1-tuples.
 *
 * @example
 * ```ts tangle:../export/zip.ts
 * import { zip } from "@thi.ng/transducers";
 *
 * console.log(
 *   [...zip([1, 2, 3], [3, 4, 5, 0, 9])]
 * );
 * // [ [ 1, 3 ] [ 2, 4 ] [ 3, 5 ] ]
 *
 * console.log(
 *   [...zip([1, 2, 3])]
 * );
 * // [ [ 1 ] [ 2 ] [ 3 ] ]
 * ```
 */
export declare function zip<A>(a: Iterable<A>): IterableIterator<[A]>;
export declare function zip<A, B>(a: Iterable<A>, b: Iterable<B>): IterableIterator<[A, B]>;
export declare function zip<A, B, C>(a: Iterable<A>, b: Iterable<B>, c: Iterable<C>): IterableIterator<[A, B, C]>;
export declare function zip<A, B, C, D>(a: Iterable<A>, b: Iterable<B>, c: Iterable<C>, d: Iterable<D>): IterableIterator<[A, B, C, D]>;
export declare function zip<A, B, C, D, E>(a: Iterable<A>, b: Iterable<B>, c: Iterable<C>, d: Iterable<D>, e: Iterable<E>): IterableIterator<[A, B, C, D, E]>;
export declare function zip<A, B, C, D, E, F>(a: Iterable<A>, b: Iterable<B>, c: Iterable<C>, d: Iterable<D>, e: Iterable<E>, f: Iterable<F>): IterableIterator<[A, B, C, D, E, F]>;
export declare function zip<A, B, C, D, E, F, G>(a: Iterable<A>, b: Iterable<B>, c: Iterable<C>, d: Iterable<D>, e: Iterable<E>, f: Iterable<F>, g: Iterable<G>): IterableIterator<[A, B, C, D, E, F, G]>;
export declare function zip<A, B, C, D, E, F, G, H>(a: Iterable<A>, b: Iterable<B>, c: Iterable<C>, d: Iterable<D>, e: Iterable<E>, f: Iterable<F>, g: Iterable<G>, h: Iterable<H>): IterableIterator<[A, B, C, D, E, F, G, H]>;
//# sourceMappingURL=zip.d.ts.map