index.js (1094B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Generate array tuples from input arrays. 23 * 24 * @module @stdlib/utils/zip 25 * 26 * @example 27 * var zip = require( '@stdlib/utils/zip' ); 28 * 29 * var zipped = zip( [ 1, 2 ], [ 'a', 'b' ] ); 30 * // returns [ [ 1, 'a' ], [ 2, 'b' ] ] 31 * 32 * var opts = { 33 * 'trunc': false 34 * }; 35 * 36 * zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], opts ); 37 * // returns [ [ 1, 'a' ], [ 2, 'b' ], [ 3, null ] ] 38 */ 39 40 // MODULES // 41 42 var zip = require( './zip.js' ); 43 44 45 // EXPORTS // 46 47 module.exports = zip;