Sha256: 83013470e39f512f7c510078bf572aa621ce07eb8fee584bc10618002089b7a2
Contents?: true
Size: 991 Bytes
Versions: 274
Compression:
Stored size: 991 Bytes
Contents
var baseExtremum = require('./_baseExtremum'),
baseGt = require('./_baseGt'),
baseIteratee = require('./_baseIteratee');
/**
* This method is like `_.max` except that it accepts `iteratee` which is
* invoked for each element in `array` to generate the criterion by which
* the value is ranked. The iteratee is invoked with one argument: (value).
*
* @static
* @memberOf _
* @since 4.0.0
* @category Math
* @param {Array} array The array to iterate over.
* @param {Function} [iteratee=_.identity] The iteratee invoked per element.
* @returns {*} Returns the maximum value.
* @example
*
* var objects = [{ 'n': 1 }, { 'n': 2 }];
*
* _.maxBy(objects, function(o) { return o.n; });
* // => { 'n': 2 }
*
* // The `_.property` iteratee shorthand.
* _.maxBy(objects, 'n');
* // => { 'n': 2 }
*/
function maxBy(array, iteratee) {
return (array && array.length)
? baseExtremum(array, baseIteratee(iteratee, 2), baseGt)
: undefined;
}
module.exports = maxBy;
Version data entries
274 entries across 272 versions & 30 rubygems