meanBy.js 900 B

1234567891011121314151617181920212223242526272829303132
  1. var baseIteratee = require('./_baseIteratee'),
  2. baseMean = require('./_baseMean');
  3. /**
  4. * This method is like `_.mean` except that it accepts `iteratee` which is
  5. * invoked for each element in `array` to generate the value to be averaged.
  6. * The iteratee is invoked with one argument: (value).
  7. *
  8. * @static
  9. * @memberOf _
  10. * @since 4.7.0
  11. * @category Math
  12. * @param {Array} array The array to iterate over.
  13. * @param {Array|Function|Object|string} [iteratee=_.identity]
  14. * The iteratee invoked per element.
  15. * @returns {number} Returns the mean.
  16. * @example
  17. *
  18. * var objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }];
  19. *
  20. * _.meanBy(objects, function(o) { return o.n; });
  21. * // => 5
  22. *
  23. * // The `_.property` iteratee shorthand.
  24. * _.meanBy(objects, 'n');
  25. * // => 5
  26. */
  27. function meanBy(array, iteratee) {
  28. return baseMean(array, baseIteratee(iteratee));
  29. }
  30. module.exports = meanBy;