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