Skip to main content

Function: unzip()

unzip<ElementType>(iterable: IterableResolvable<ElementType>): UnzipIterable<ElementType>

Creates an array for each element of the input iterable, transposing the input iterable. The opposite of zip.

Type parameters

Type parameter
ElementType extends readonly any[]

Parameters

ParameterTypeDescription
iterableIterableResolvable<ElementType>An iterable to unzip.

Returns

UnzipIterable<ElementType>

An array of iterables that yield the values of the original iterable.

Example

import { unzip } from '@sapphire/iterator-utilities';

const iterable = [[1, 'a'], [2, 'b'], [3, 'c']];
const [numbers, letters] = unzip(iterable);

console.log(numbers);
// Output: [1, 2, 3]

console.log(letters);
// Output: ['a', 'b', 'c']

Remarks

This function consumes the entire iterable.

Source

projects/utilities/packages/iterator-utilities/src/lib/unzip.ts:28