mirror of
https://github.com/toss/es-toolkit.git
synced 2025-01-08 09:18:51 +03:00
docs: Add detail examples to docs in maxBy, minBy (#554)
* docs: Add detail examples to docs in maxBy, minBy * docs: Add examples for maxBy and minBy functions to en, ja, zh_hans docs
This commit is contained in:
parent
1ba076a2ac
commit
53703f4abb
@ -24,4 +24,12 @@ function maxBy<T>(items: T[], getValue: (element: T) => number): T;
|
||||
```typescript
|
||||
maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // 戻り値: { a: 3 }
|
||||
maxBy([], x => x.a); // 戻り値: undefined
|
||||
maxBy(
|
||||
[
|
||||
{ name: 'john', age: 30 },
|
||||
{ name: 'jane', age: 28 },
|
||||
{ name: 'joe', age: 26 },
|
||||
],
|
||||
x => x.age
|
||||
); // 戻り値: { name: 'john', age: 30 }
|
||||
```
|
||||
|
@ -22,4 +22,12 @@ function minBy<T>(items: T[], getValue: (element: T) => number): T;
|
||||
```typescript
|
||||
minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // 戻り値: { a: 1 }
|
||||
minBy([], x => x.a); // 戻り値: undefined
|
||||
minBy(
|
||||
[
|
||||
{ name: 'john', age: 30 },
|
||||
{ name: 'jane', age: 28 },
|
||||
{ name: 'joe', age: 26 },
|
||||
],
|
||||
x => x.age
|
||||
); // 戻り値: { name: 'joe', age: 26 }
|
||||
```
|
||||
|
@ -25,4 +25,12 @@ function maxBy<T>(items: T[], getValue: (element: T) => number): T | undefined;
|
||||
```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 }
|
||||
```
|
||||
|
@ -23,4 +23,12 @@ function minBy<T>(items: T[], getValue: (element: T) => number): T | undefined;
|
||||
```typescript
|
||||
minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }
|
||||
minBy([], x => x.a); // Returns: undefined
|
||||
minBy(
|
||||
[
|
||||
{ name: 'john', age: 30 },
|
||||
{ name: 'jane', age: 28 },
|
||||
{ name: 'joe', age: 26 },
|
||||
],
|
||||
x => x.age
|
||||
); // Returns: { name: 'joe', age: 26 }
|
||||
```
|
||||
|
@ -23,4 +23,12 @@ function maxBy<T>(items: T[], getValue: (element: T) => number): T | undefined;
|
||||
```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 }
|
||||
```
|
||||
|
@ -23,4 +23,12 @@ function minBy<T>(items: T[], getValue: (element: T) => number): T | undefined;
|
||||
```typescript
|
||||
minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }
|
||||
minBy([], x => x.a); // Returns: undefined
|
||||
minBy(
|
||||
[
|
||||
{ name: 'john', age: 30 },
|
||||
{ name: 'jane', age: 28 },
|
||||
{ name: 'joe', age: 26 },
|
||||
],
|
||||
x => x.age
|
||||
); // Returns: { name: 'joe', age: 26 }
|
||||
```
|
||||
|
@ -25,4 +25,12 @@ function maxBy<T>(items: T[], getValue: (element: T) => number): T | undefined;
|
||||
```typescript
|
||||
maxBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // 返回: { a: 3 }
|
||||
maxBy([], x => x.a); // 返回: undefined
|
||||
maxBy(
|
||||
[
|
||||
{ name: 'john', age: 30 },
|
||||
{ name: 'jane', age: 28 },
|
||||
{ name: 'joe', age: 26 },
|
||||
],
|
||||
x => x.age
|
||||
); // 返回: { name: 'john', age: 30 }
|
||||
```
|
||||
|
@ -25,4 +25,12 @@ function minBy<T>(items: T[], getValue: (element: T) => number): T | undefined;
|
||||
```typescript
|
||||
minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // 返回: { a: 1 }
|
||||
minBy([], x => x.a); // 返回: undefined
|
||||
minBy(
|
||||
[
|
||||
{ name: 'john', age: 30 },
|
||||
{ name: 'jane', age: 28 },
|
||||
{ name: 'joe', age: 26 },
|
||||
],
|
||||
x => x.age
|
||||
); // 返回: { name: 'joe', age: 26 }
|
||||
```
|
||||
|
@ -9,6 +9,14 @@
|
||||
* @example
|
||||
* 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 }
|
||||
*/
|
||||
export function maxBy<T>(items: readonly [T, ...T[]], getValue: (element: T) => number): T;
|
||||
/**
|
||||
@ -22,6 +30,14 @@ export function maxBy<T>(items: readonly [T, ...T[]], getValue: (element: T) =>
|
||||
* @example
|
||||
* 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 }
|
||||
*/
|
||||
export function maxBy<T>(items: readonly T[], getValue: (element: T) => number): T | undefined;
|
||||
/**
|
||||
@ -35,6 +51,14 @@ export function maxBy<T>(items: readonly T[], getValue: (element: T) => number):
|
||||
* @example
|
||||
* 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 }
|
||||
*/
|
||||
export function maxBy<T>(items: readonly T[], getValue: (element: T) => number): T {
|
||||
let maxElement = items[0];
|
||||
|
@ -9,6 +9,14 @@
|
||||
* @example
|
||||
* minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }
|
||||
* minBy([], x => x.a); // Returns: undefined
|
||||
* minBy(
|
||||
* [
|
||||
* { name: 'john', age: 30 },
|
||||
* { name: 'jane', age: 28 },
|
||||
* { name: 'joe', age: 26 },
|
||||
* ],
|
||||
* x => x.age
|
||||
* ); // Returns: { name: 'joe', age: 26 }
|
||||
*/
|
||||
export function minBy<T>(items: readonly [T, ...T[]], getValue: (element: T) => number): T;
|
||||
/**
|
||||
@ -22,6 +30,14 @@ export function minBy<T>(items: readonly [T, ...T[]], getValue: (element: T) =>
|
||||
* @example
|
||||
* minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }
|
||||
* minBy([], x => x.a); // Returns: undefined
|
||||
* minBy(
|
||||
* [
|
||||
* { name: 'john', age: 30 },
|
||||
* { name: 'jane', age: 28 },
|
||||
* { name: 'joe', age: 26 },
|
||||
* ],
|
||||
* x => x.age
|
||||
* ); // Returns: { name: 'joe', age: 26 }
|
||||
*/
|
||||
export function minBy<T>(items: readonly T[], getValue: (element: T) => number): T | undefined;
|
||||
/**
|
||||
@ -35,6 +51,14 @@ export function minBy<T>(items: readonly T[], getValue: (element: T) => number):
|
||||
* @example
|
||||
* minBy([{ a: 1 }, { a: 2 }, { a: 3 }], x => x.a); // Returns: { a: 1 }
|
||||
* minBy([], x => x.a); // Returns: undefined
|
||||
* minBy(
|
||||
* [
|
||||
* { name: 'john', age: 30 },
|
||||
* { name: 'jane', age: 28 },
|
||||
* { name: 'joe', age: 26 },
|
||||
* ],
|
||||
* x => x.age
|
||||
* ); // Returns: { name: 'joe', age: 26 }
|
||||
*/
|
||||
export function minBy<T>(items: readonly T[], getValue: (element: T) => number): T | undefined {
|
||||
let minElement = items[0];
|
||||
|
Loading…
Reference in New Issue
Block a user