https://github.com/stdlib-js/array-base-zip2views
Zip one or more arrays to an array of composite views.
https://github.com/stdlib-js/array-base-zip2views
array generic javascript node node-js nodejs object stdlib tidy utilities utils zip
Last synced: about 1 month ago
JSON representation
Zip one or more arrays to an array of composite views.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-base-zip2views
- Owner: stdlib-js
- License: apache-2.0
- Created: 2025-07-27T05:51:50.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-02-16T02:20:55.000Z (4 months ago)
- Last Synced: 2026-04-08T07:23:36.434Z (2 months ago)
- Topics: array, generic, javascript, node, node-js, nodejs, object, stdlib, tidy, utilities, utils, zip
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 452 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
- Notice: NOTICE
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# zip2views
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Zip one or more arrays to an array of composite views.
## Installation
```bash
npm install @stdlib/array-base-zip2views
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var zip2views = require( '@stdlib/array-base-zip2views' );
```
#### zip2views( arrays, labels )
Zips one or more arrays to an array of composite views.
```javascript
var x = [ 1, 2, 3 ];
var y = [ 'a', 'b', 'c' ];
var labels = [ 'x', 'y' ];
var z = zip2views( [ x, y ], labels );
// returns [ , , ]
var v0 = z[ 0 ].toJSON();
// returns { 'x': 1, 'y': 'a' }
var v1 = z[ 1 ].toJSON();
// returns { 'x': 2, 'y': 'b' }
var v2 = z[ 2 ].toJSON();
// returns { 'x': 3, 'y': 'c' }
// Mutate one of the input arrays:
x[ 0 ] = 5;
v0 = z[ 0 ].toJSON();
// returns { 'x': 5, 'y': 'a' }
// Set a view property:
z[ 1 ].y = 'beep';
v1 = z[ 1 ].toJSON();
// returns { 'x': 2, 'y': 'beep' }
var y1 = y.slice();
// returns [ 'a', 'beep', 'c' ]
```
The function supports the following parameters:
- **arrays**: list of arrays to zip.
- **labels**: list of array labels.
Each element in the returned array is a class instance having prototype properties corresponding to the list of array labels. As demonstrated in the example above, to convert an element to a regular object, invoke an element's `toJSON` method. Note, however, that the object returned by an element's `toJSON` method no longer shares the same memory as the provided input arrays.
- The function assumes that the list of arrays to be zipped all have the same length.
- The number of provided array labels should equal the number of arrays to be zipped.
- Each view in the returned array shares the same memory as the corresponding elements in the input arrays. Accordingly, mutation of either an input array or a view will mutate the other.
## Examples
```javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var zeroTo = require( '@stdlib/array-base-zero-to' );
var zip2views = require( '@stdlib/array-base-zip2views' );
var x = zeroTo( 10 );
var y = discreteUniform( x.length, -100, 100 );
var labels = [ 'x', 'y' ];
var out = zip2views( [ x, y ], labels );
// returns [...]
```
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/array-base-zip2views.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-base-zip2views
[test-image]: https://github.com/stdlib-js/array-base-zip2views/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-base-zip2views/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-zip2views/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-base-zip2views?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/array-base-zip2views/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-base-zip2views/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-base-zip2views/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-base-zip2views/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-base-zip2views/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-base-zip2views/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-base-zip2views/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-zip2views/main/LICENSE