mirror of
https://github.com/toss/es-toolkit.git
synced 2024-11-28 03:34:26 +03:00
53703f4abb
* docs: Add detail examples to docs in maxBy, minBy * docs: Add examples for maxBy and minBy functions to en, ja, zh_hans docs
35 lines
880 B
Markdown
35 lines
880 B
Markdown
# maxBy
|
|
|
|
Finds the element in an array that has the maximum value when applying the `getValue` function to each element.
|
|
|
|
## Signature
|
|
|
|
```typescript
|
|
function maxBy<T>(items: [T, ...T[]], getValue: (element: T) => number): T;
|
|
function maxBy<T>(items: T[], getValue: (element: T) => number): T | undefined;
|
|
```
|
|
|
|
### Parameters
|
|
|
|
- `items` (`T[]`): The array of elements to search.
|
|
- `getValue` (`(item: T) => number`): A function that selects a numeric value from each element.
|
|
|
|
### Returns
|
|
|
|
(`T`): The element with the maximum value as determined by the `getValue` function.
|
|
|
|
## Example
|
|
|
|
```typescript
|
|
maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 3 }
|
|
maxBy([], x => x.a); // Returns: undefined
|
|
maxBy(
|
|
[
|
|
{ name: 'john', age: 30 },
|
|
{ name: 'jane', age: 28 },
|
|
{ name: 'joe', age: 26 },
|
|
],
|
|
x => x.age
|
|
); // Returns: { name: 'john', age: 30 }
|
|
```
|