External module "utils/zip/docs/types/index.d"

Export assignment zip

• zip(arr0: Array<any>, arr1: Array<any>, options?: Options): Array<Array<any>>
• zip(arr0: Array<any>, arr1: Array<any>, arr2: Array<any>, options?: Options): Array<Array<any>>
• zip(arr0: Array<any>, arr1: Array<any>, arr2: Array<any>, arr3: Array<any>, options?: Options): Array<Array<any>>
• zip(arr0: Array<any>, arr1: Array<any>, ...args: Array<Array<any> | Options>): Array<Array<any>>

• Generates array tuples from input arrays.

  Parameters

  • arr0: Array<any>

    first input array

  • arr1: Array<any>

    second input array

  • Optional options: Options

    function options

  Returns Array < Array < any > >

  output array of arrays

  Example

  var zipped = zip( [ 1, 2 ], [ 'a', 'b' ] );
  // returns [ [ 1, 'a' ], [ 2, 'b' ] ]

  Example

  var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ] );
  // returns [ [ 1, 'a' ], [ 2, 'b' ] ]

  Example

  var opts = {
      'trunc': false
  };
  
  var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], opts );
  // returns [ [ 1, 'a' ], [ 2, 'b' ], [ 3, null ] ]

  Example

  var opts = {
      'trunc': false,
      'fill': ''
  };
  
  var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], opts );
  // returns [ [ 1, 'a' ], [ 2, 'b' ], [ 3, '' ] ]

  Example

  var arr = [ [ 1, 2 ], [ 'a', 'b' ] ];
  
  // Default behavior:
  var zipped = zip( arr );
  // returns [ [ [ 1, 2 ] ], [ [ 'a', 'b' ] ] ]
  
  // Array of arrays:
  zipped = zip( arr, { 'arrays': true } );
  // returns [ [ 1, 'a' ], [ 2, 'b' ] ]

• Generates array tuples from input arrays.

  Parameters

  • arr0: Array<any>

    first input array

  • arr1: Array<any>

    second input array

  • arr2: Array<any>

    third input array

  • Optional options: Options

    function options

  Returns Array < Array < any > >

  output array of arrays

  Example

  var zipped = zip( [ 1, 2 ], [ 'a', 'b' ], [ true, false ] );
  // returns [ [ 1, 'a', true ], [ 2, 'b', false ] ]

  Example

  var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], [ true, false ] );
  // returns [ [ 1, 'a', true ], [ 2, 'b', false ] ]

  Example

  var opts = {
      'trunc': false
  };
  
  var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], [ true, false, true ], opts );
  // returns [ [ 1, 'a', true ], [ 2, 'b', false ], [ 3, null, true ] ]

  Example

  var opts = {
      'trunc': false,
      'fill': ''
  };
  
  var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], [ true, false, true ], opts );
  // returns [ [ 1, 'a', true ], [ 2, 'b', false ], [ 3, '', true ] ]

  Example

  var arr = [ [ 1, 2 ], [ 'a', 'b' ], [ true, false ] ];
  
  // Default behavior:
  var zipped = zip( arr );
  // returns [ [ [ 1, 2 ] ], [ [ 'a', 'b' ] ], [ [ true, false ] ] ]
  
  // Array of arrays:
  zipped = zip( arr, { 'arrays': true } );
  // returns [ [ 1, 'a', true ], [ 2, 'b', false ] ]

• Generates array tuples from input arrays.

  Parameters

  • arr0: Array<any>

    first input array

  • arr1: Array<any>

    second input array

  • arr2: Array<any>

    third input array

  • arr3: Array<any>

    fourth input array

  • Optional options: Options

    function options

  Returns Array < Array < any > >

  output array of arrays

  Example

  var zipped = zip( [ 1, 2 ], [ 'a', 'b' ], [ true, false ], [ {}, {} ] );
  // returns [ [ 1, 'a', true, {} ], [ 2, 'b', false, {} ] ]

  Example

  var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], [ true, false ], [ {}, {} ] );
  // returns [ [ 1, 'a', true, {} ], [ 2, 'b', false, {} ] ]

  Example

  var opts = {
      'trunc': false
  };
  
  var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], [ true, false, true ], [ {}, {}, {} ], opts );
  // returns [ [ 1, 'a', true, {} ], [ 2, 'b', false, {} ], [ 3, null, true, {} ] ]

  Example

  var opts = {
      'trunc': false,
      'fill': ''
  };
  
  var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], [ true, false, true ], [ {}, {}, {} ], opts );
  // returns [ [ 1, 'a', true, {} ], [ 2, 'b', false, {} ], [ 3, '', true, {} ] ]

  Example

  var arr = [ [ 1, 2 ], [ 'a', 'b' ], [ true, false ], [ {}, {} ] ];
  
  // Default behavior:
  var zipped = zip( arr );
  // returns [ [ [ 1, 2 ] ], [ [ 'a', 'b' ] ], [ [ true, false ] ], [ [ {}, {} ] ] ]
  
  // Array of arrays:
  zipped = zip( arr, { 'arrays': true } );
  // returns [ [ 1, 'a', true, {} ], [ 2, 'b', false, {} ] ]

• Generates array tuples from input arrays.

  Parameters

  • arr0: Array<any>

    first input array

  • arr1: Array<any>

    second input array

  • Rest ...args: Array<Array<any> | Options>

    subsequent arrays followed by an optional options object

  Returns Array < Array < any > >

  output array of arrays

  Example

  var zipped = zip( [ 1, 2 ], [ 'a', 'b' ] );
  // returns [ [ 1, 'a' ], [ 2, 'b' ] ]

  Example

  var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ] );
  // returns [ [ 1, 'a' ], [ 2, 'b' ] ]

  Example

  var opts = {
      'trunc': false
  };
  
  var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], opts );
  // returns [ [ 1, 'a' ], [ 2, 'b' ], [ 3, null ] ]

  Example

  var opts = {
      'trunc': false,
      'fill': ''
  };
  
  var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], opts );
  // returns [ [ 1, 'a' ], [ 2, 'b' ], [ 3, '' ] ]

  Example

  var arr = [ [ 1, 2 ], [ 'a', 'b' ] ];
  
  // Default behavior:
  var zipped = zip( arr );
  // returns [ [ [ 1, 2 ] ], [ [ 'a', 'b' ] ] ]
  
  // Array of arrays:
  zipped = zip( arr, { 'arrays': true } );
  // returns [ [ 1, 'a' ], [ 2, 'b' ] ]