summaryrefslogtreecommitdiff
path: root/tools/eslint/node_modules/lodash/maxBy.js
diff options
context:
space:
mode:
Diffstat (limited to 'tools/eslint/node_modules/lodash/maxBy.js')
-rw-r--r--tools/eslint/node_modules/lodash/maxBy.js33
1 files changed, 33 insertions, 0 deletions
diff --git a/tools/eslint/node_modules/lodash/maxBy.js b/tools/eslint/node_modules/lodash/maxBy.js
new file mode 100644
index 0000000000..c70395fbfc
--- /dev/null
+++ b/tools/eslint/node_modules/lodash/maxBy.js
@@ -0,0 +1,33 @@
+var baseExtremum = require('./_baseExtremum'),
+ baseIteratee = require('./_baseIteratee'),
+ gt = require('./gt');
+
+/**
+ * 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 _
+ * @category Math
+ * @param {Array} array The array to iterate over.
+ * @param {Function|Object|string} [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), gt)
+ : undefined;
+}
+
+module.exports = maxBy;