www.aleph1.co.uk Git - yaffs-website/blob - node_modules/uncss/node_modules/lodash/maxBy.js

   1 var baseExtremum = require('./internal/baseExtremum'),
   2     baseIteratee = require('./internal/baseIteratee'),
   3     gt = require('./gt');
   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  * @category Math
  13  * @param {Array} array The array to iterate over.
  14  * @param {Function|Object|string} [iteratee=_.identity] The iteratee invoked per element.
  15  * @returns {*} Returns the maximum value.
  16  * @example
  17  *
  18  * var objects = [{ 'n': 1 }, { 'n': 2 }];
  19  *
  20  * _.maxBy(objects, function(o) { return o.n; });
  21  * // => { 'n': 2 }
  22  *
  23  * // using the `_.property` iteratee shorthand
  24  * _.maxBy(objects, 'n');
  25  * // => { 'n': 2 }
  26  */
  27 function maxBy(array, iteratee) {
  28   return (array && array.length)
  29     ? baseExtremum(array, baseIteratee(iteratee), gt)
  30     : undefined;
  31 }
  32
  33 module.exports = maxBy;