mapPairs()

Creates a new array or object corresponding to the array-like structure or object supplied where the keys and values to the new array or object are determined by a callback function.

This function is valid in v2.19.0 to v2.24.3. This function has been downloaded 44 times.

Parameters

{Array|Object} objectOrArray
The array, array-like structure or object whose items or properties will be traversed by callback.
{Function} callback
Function that produces a key and value pair that will be used to define each item or property in the structure (Array or Object) corresponding to objectOrArray. The first argument passed will be current value of the item or property. The second argument will be the index or property name. The third argument will be a reference to objectOrArray. If the return value is false-ish the property or item will not be added to the object returned by mapPairs(). Otherwise the return value should be an array where the first value is the key and the second value is the value of the item or property that should be added to the object returned by mapPairs().
{*=} opt_thisArg Optional, Default:global
Value to use as this when executing callback.

Returns

{Array|Object}
If objectOrArray is an array-like structure then a new array with the modified keys and values will be returned. Otherwise a new object with the keys and values will be returned.

Required Function

This function directly requires the following function which is included automatically:

  • map()
    Creates a new array or object with the results of calling a provided function on every item or property in the given object.

Requiring Function

This function is directly required by the following function:

  • map()
    Creates a new array or object with the results of calling a provided function on every item or property in the given object.