zip
arrays
Creates an array of grouped elements, the first of which contains the first elements of the given arrays, the second of which contains the second elements of the given arrays, and so on.
Installation
Import
import { zip } from '@tulx/utils';Source Code
Implementation
/**
* Creates an array of grouped elements, the first of which contains the first elements of the given arrays,
* the second of which contains the second elements of the given arrays, and so on.
*
* @param arrays - The arrays to process.
* @returns The new array of grouped elements.
*
* @example
* ```ts
* zip(['a', 'b'], [1, 2], [true, false]); // [['a', 1, true], ['b', 2, false]]
* ```
*/
export function zip<T extends unknown[]>(
...arrays: { [K in keyof T]: T[K][] }
): Array<{ [K in keyof T]: T[K] }> {
if (arrays.length === 0) {
return [];
}
const maxLength = Math.max(...arrays.map((arr) => arr.length));
const result: Array<{ [K in keyof T]: T[K] }> = [];
for (let i = 0; i < maxLength; i++) {
const tuple = arrays.map((arr) => arr[i]) as { [K in keyof T]: T[K] };
result.push(tuple);
}
return result;
}
Example
import { zip } from '@tulx/utils';
zip(['a', 'b'], [1, 2], [true, false]); // [['a', 1, true], ['b', 2, false]]Related Functions
chunk
Creates an array of elements split into groups the length of size. If array can't be split evenly, the final chunk will be the remaining elements.
compact
Creates an array with all falsy values removed. The values false, null, 0, "", undefined, and NaN are falsy.
concat
Creates a new array concatenating array with any additional arrays and/or values.
difference
Creates an array of array values not included in the other given arrays. The order and references of result values are determined by the first array.
differenceBy
This method is like difference except that it accepts iteratee which is invoked for each element of array and values to generate the criterion by which they're compared.
differenceWith
This method is like difference except that it accepts comparator which is invoked to compare elements of array to values.