reduceBy.js 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. import _clone from "./internal/_clone.js";
  2. import _curryN from "./internal/_curryN.js";
  3. import _dispatchable from "./internal/_dispatchable.js";
  4. import _has from "./internal/_has.js";
  5. import _reduced from "./internal/_reduced.js";
  6. import _xReduce from "./internal/_xReduce.js";
  7. import _xreduceBy from "./internal/_xreduceBy.js";
  8. import _xwrap from "./internal/_xwrap.js";
  9. /**
  10. * Groups the elements of the list according to the result of calling
  11. * the String-returning function `keyFn` on each element and reduces the elements
  12. * of each group to a single value via the reducer function `valueFn`.
  13. *
  14. * The value function receives two values: *(acc, value)*. It may use
  15. * [`R.reduced`](#reduced) to short circuit the iteration.
  16. *
  17. * This function is basically a more general [`groupBy`](#groupBy) function.
  18. *
  19. * Acts as a transducer if a transformer is given in list position.
  20. *
  21. * @func
  22. * @memberOf R
  23. * @since v0.20.0
  24. * @category List
  25. * @sig ((a, b) -> a) -> a -> (b -> String) -> [b] -> {String: a}
  26. * @param {Function} valueFn The function that reduces the elements of each group to a single
  27. * value. Receives two values, accumulator for a particular group and the current element.
  28. * @param {*} acc The (initial) accumulator value for each group.
  29. * @param {Function} keyFn The function that maps the list's element into a key.
  30. * @param {Array} list The array to group.
  31. * @return {Object} An object with the output of `keyFn` for keys, mapped to the output of
  32. * `valueFn` for elements which produced that key when passed to `keyFn`.
  33. * @see R.groupBy, R.reduce, R.reduced
  34. * @example
  35. *
  36. * const groupNames = (acc, {name}) => acc.concat(name)
  37. * const toGrade = ({score}) =>
  38. * score < 65 ? 'F' :
  39. * score < 70 ? 'D' :
  40. * score < 80 ? 'C' :
  41. * score < 90 ? 'B' : 'A'
  42. *
  43. * var students = [
  44. * {name: 'Abby', score: 83},
  45. * {name: 'Bart', score: 62},
  46. * {name: 'Curt', score: 88},
  47. * {name: 'Dora', score: 92},
  48. * ]
  49. *
  50. * reduceBy(groupNames, [], toGrade, students)
  51. * //=> {"A": ["Dora"], "B": ["Abby", "Curt"], "F": ["Bart"]}
  52. */
  53. var reduceBy =
  54. /*#__PURE__*/
  55. _curryN(4, [],
  56. /*#__PURE__*/
  57. _dispatchable([], _xreduceBy, function reduceBy(valueFn, valueAcc, keyFn, list) {
  58. var xf = _xwrap(function (acc, elt) {
  59. var key = keyFn(elt);
  60. var value = valueFn(_has(key, acc) ? acc[key] : _clone(valueAcc, false), elt);
  61. if (value && value['@@transducer/reduced']) {
  62. return _reduced(acc);
  63. }
  64. acc[key] = value;
  65. return acc;
  66. });
  67. return _xReduce(xf, {}, list);
  68. }));
  69. export default reduceBy;