www.aleph1.co.uk Git - yaffs-website/blob - node_modules/grunt-contrib-watch/node_modules/globule/node_modules/lodash/maxBy.js

   1 var baseExtremum = require('./_baseExtremum'),
   2     baseGt = require('./_baseGt'),
   3     baseIteratee = require('./_baseIteratee');
   4
   5 /**
   6  * This method is like `_.max` except that it accepts `iteratee` which is
   7  * invoked for each element in `array` to generate the criterion by which
   8  * the value is ranked. The iteratee is invoked with one argument: (value).
   9  *
  10  * @static
  11  * @memberOf _
  12  * @since 4.0.0
  13  * @category Math
  14  * @param {Array} array The array to iterate over.
  15  * @param {Function} [iteratee=_.identity] The iteratee invoked per element.
  16  * @returns {*} Returns the maximum value.
  17  * @example
  18  *
  19  * var objects = [{ 'n': 1 }, { 'n': 2 }];
  20  *
  21  * _.maxBy(objects, function(o) { return o.n; });
  22  * // => { 'n': 2 }
  23  *
  24  * // The `_.property` iteratee shorthand.
  25  * _.maxBy(objects, 'n');
  26  * // => { 'n': 2 }
  27  */
  28 function maxBy(array, iteratee) {
  29   return (array && array.length)
  30     ? baseExtremum(array, baseIteratee(iteratee, 2), baseGt)
  31     : undefined;
  32 }
  33
  34 module.exports = maxBy;