101/index-by.js

common javascript utils that can be required selectively that assume es5+

/**
 * @module 101/index-by
 */

var isString = require('./is-string');
var isFunction = require('./is-function');
var pluck = require('./pluck');

/**
 * Hashes an array based on the value of a provided common key.
 * @function module:101/index-by
 * @param {array|function|string} arr|indexer - array of objects to be indexed
 * @param {string|function} indexer - the common keypath or function which accepts an object and returns an index key
 * @return {obj|function} indexed|indexByPartial An object whose keys are the values of their common key and values are the original values.
 *     Or a partial function which applies the passed indexer to each object.
*/
module.exports = function(arrOrIndexer, indexer) {
  var arr;
  if (Array.isArray(arrOrIndexer)) {
    arr = arrOrIndexer;
    return arr.reduce(indexBy(indexer), {});
  }
  else {
    indexer = arrOrIndexer;
    if (!isString(indexer) && !isFunction(indexer)) {
      throw new TypeError('indexer must be a string or function');
    }
    return indexBy(indexer);
  }
}

function indexBy (indexer) {
  if (isString(indexer)) {
    indexer = pluck(indexer);
  }
  return function(prev, cur, index, arr) {
    prev[indexer(cur)] = cur;
    return prev;
  };
}