Computes the maximum value of array. If array is empty or falsey, undefined is returned. Part of Lodash 4.x Math (since 0.1.0).
Pass the numbers or collection shown below. Check the return value before you chain another math helper.
Call _.max. Start with this line.
_.max(array)| Call | What it does |
|---|---|
_.max(array) | Primary signature. |
Prefer import max from "lodash/max" when you want a smaller bundle.
_.max(array)| Parameter | Description |
|---|---|
| array | Required. Collection to scan |
| Return Value | Description |
|---|---|
| * | Maximum value, or undefined if empty/falsey |
Find the largest number in a list.
_.max([4, 2, 8, 6]);
// → 88 wins — same as the official docs.undefinedNo values means no maximum.
[
_.max([]),
_.max(null),
_.max(undefined)
];
// → [undefined, undefined, undefined]array && array.length.undefined — not -Infinity._.max(arr) ?? 0 when needed.Works the same for negatives — larger means closer to +∞.
_.max([-10, -3, -7]);
// → -3-3 > -7 and -3 > -10.-3 is the maximum._.min([-10, -3, -7]) → -10.NaNInvalid numeric candidates are ignored while scanning.
[
_.max([1, NaN, 3]),
_.max([NaN, NaN])
];
// → [3, undefined]NaN (and typically null / undefined) is not kept as a candidate.3.NaN values → undefined.max vs maxByObjects need an iteratee — that is maxBy, not max.
var users = [
{ name: "a", age: 20 },
{ name: "b", age: 40 },
{ name: "c", age: 30 }
];
_.maxBy(users, "age");
// → { name: "b", age: 40 }
// _.max(users) is not useful for object scores"age" (or a function)._.max is ignored in Lodash 4.x.max. Objects → maxBy._.max is a Lodash 4.x Math helper (since 0.1.0). It needs no special browser APIs beyond loading Lodash.
Available in [email protected] full builds and the lodash/max modular import. Works in evergreen browsers and Node / Bun / Deno when Lodash is installed.
Bottom line: Safe for production once Lodash is on the page or in your bundle. Prefer import max from "lodash/max" for smaller builds.
Find the maximum element using a property path or iteratee.
10 people found this page helpful