1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151 |
x6
x6
x6
x6
x24
x24
x24
x77
x77
x106
x106
x106
x77
x24
x24 |
|
// Copyright 2018-2025 the Deno authors. MIT license.
// This module is browser compatible.
/**
* Returns the first element that is the smallest value of the given function or
* undefined if there are no elements.
*
* @typeParam T The type of the elements in the array.
*
* @param array The array to find the minimum element in.
* @param selector The function to get the value to compare from each element.
*
* @returns The first element that is the smallest value of the given function
* or undefined if there are no elements.
*
* @example Basic usage
* ```ts
* import { minBy } from "@std/collections/min-by";
* import { assertEquals } from "@std/assert";
*
* const people = [
* { name: "Anna", age: 34 },
* { name: "Kim", age: 42 },
* { name: "John", age: 23 },
* ];
*
* const personWithMinAge = minBy(people, (i) => i.age);
*
* assertEquals(personWithMinAge, { name: "John", age: 23 });
* ```
*/
export function minBy<T>(
array: Iterable<T>,
selector: (el: T) => number,
): T | undefined;
/**
* Returns the first element that is the smallest value of the given function or
* undefined if there are no elements.
*
* @typeParam T The type of the elements in the array.
*
* @param array The array to find the minimum element in.
* @param selector The function to get the value to compare from each element.
*
* @returns The first element that is the smallest value of the given function
* or undefined if there are no elements.
*
* @example Basic usage
* ```ts
* import { minBy } from "@std/collections/min-by";
* import { assertEquals } from "@std/assert";
*
* const people = [
* { name: "Anna" },
* { name: "Kim" },
* { name: "John" },
* ];
*
* const personWithMinName = minBy(people, (person) => person.name);
*
* assertEquals(personWithMinName, { name: "Anna" });
* ```
*/
export function minBy<T>(
array: Iterable<T>,
selector: (el: T) => string,
): T | undefined;
/**
* Returns the first element that is the smallest value of the given function or
* undefined if there are no elements.
*
* @typeParam T The type of the elements in the array.
*
* @param array The array to find the minimum element in.
* @param selector The function to get the value to compare from each element.
*
* @returns The first element that is the smallest value of the given function
* or undefined if there are no elements.
*
* @example Basic usage
* ```ts
* import { minBy } from "@std/collections/min-by";
* import { assertEquals } from "@std/assert";
*
* const people = [
* { name: "Anna", age: 34n },
* { name: "Kim", age: 42n },
* { name: "John", age: 23n },
* ];
*
* const personWithMinAge = minBy(people, (i) => i.age);
*
* assertEquals(personWithMinAge, { name: "John", age: 23n });
* ```
*/
export function minBy<T>(
array: Iterable<T>,
selector: (el: T) => bigint,
): T | undefined;
/**
* Returns the first element that is the smallest value of the given function or
* undefined if there are no elements.
*
* @typeParam T The type of the elements in the array.
*
* @param array The array to find the minimum element in.
* @param selector The function to get the value to compare from each element.
*
* @returns The first element that is the smallest value of the given function
* or undefined if there are no elements.
*
* @example Basic usage
* ```ts
* import { minBy } from "@std/collections/min-by";
* import { assertEquals } from "@std/assert";
*
* const people = [
* { name: "Anna", startedAt: new Date("2020-01-01") },
* { name: "Kim", startedAt: new Date("2020-03-01") },
* { name: "John", startedAt: new Date("2019-01-01") },
* ];
*
* const personWithMinStartedAt = minBy(people, (person) => person.startedAt);
* ```
*/
export function minBy<T>(
array: Iterable<T>,
selector: (el: T) => Date,
): T | undefined;
export function minBy<T>(
array: Iterable<T>,
selector:
| ((el: T) => number)
| ((el: T) => string)
| ((el: T) => bigint)
| ((el: T) => Date),
): T | undefined {
let min: T | undefined;
let minValue: ReturnType<typeof selector> | undefined;
for (const current of array) {
const currentValue = selector(current);
if (minValue === undefined || currentValue < minValue) {
min = current;
minValue = currentValue;
}
}
return min;
}
|