https://github.com/marco-ippolito/proposal-array-zip
Proposal to add Array.zip to JavaScript
https://github.com/marco-ippolito/proposal-array-zip
Last synced: 4 months ago
JSON representation
Proposal to add Array.zip to JavaScript
- Host: GitHub
- URL: https://github.com/marco-ippolito/proposal-array-zip
- Owner: marco-ippolito
- License: mit
- Created: 2024-01-15T13:46:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-11T09:57:52.000Z (over 1 year ago)
- Last Synced: 2025-04-06T04:51:34.898Z (6 months ago)
- Language: HTML
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Array.zip for JavaScript
Champions: Marco Ippolito
Author: Marco Ippolito
Stage: 0
This is a proposal to add the static method `zip` to JavaScript's built-in `Array` class.
## Motivation
Addressing element-wise array combination in JavaScript is a common problem.
The existing solutions in JavaScript lack ergonomic and performance.
The absence of a dedicated `Array.zip` method leaves developers resorting to intricate workarounds.
These workarounds are not efficient and potentially potentially error prone.
## Comparison with other languages
See [other languages document](./other-languages.md) to get overview of `Array.zip` methods in other languages.
## Proposal
The `Array.zip` method enriches the JavaScript Array class with a tool for element-wise array combination.
This would add the following method:
* `Array.zip(...arrays)`
* `Array.zip(...arrays, mapFn)`
* `Array.zip(...arrays, mapFn, thisArg)`
### Parameters
* `args` - Arrays to zip.
* `mapFn` - Function to call on every element of the zipped arrays. It accepts the following arguments:
* `...args` - N-th elements of the zipped arrays in order.
* `index` - The index of the element in the original array.
* `array` - The original array.
* `thisArg` - Value to use as `this` when executing `mapFn`.
## Examples
```js
// zips two arrays
Array.zip(['a', 'b', 'c'], [1, 2, 3]) // [['a', 1], ['b', 2], ['c', 3]]
// zips three arrays
Array.zip(['a', 'b', 'c'], [1, 2, 3], [true, false, true]) // [['a', 1, true], ['b', 2, false], ['c', 3, true]]
```
If arrays have different sized, the resulting array will have the length of the shortest array:
```js
Array.zip(['a', 'b', 'c'], [1, 2]) // [['a', 1], ['b', 2]]
```
Using the mapFn argument:
```js
Array.zip(['a', 'b', 'c'], [1, 2, 3], (a, b, index, array) => ({ [a]: b })) // [{ a: 1}, {b: 2}, {c: 3}]
```
Using the mapFn with 3 arguments:
```js
Array.zip(['a', 'b', 'c'], [1, 2, 3], [true, false, true], (a, b, c, index, array) => ({ [a]: c ? b : null })) // [{ a: 1}, {b: null}, {c: 3}]
```
Using the mapFn and thisArg arguments:
```js
Array.zip(['a', 'b', 'c'], [1, 2, 3], (a, b, index, array) => ({ [a]: b + this.offset }), { offset: 10 }) // [{ a: 11}, {b: 12}, {c: 13}]
```