UNPKG

es-toolkit

Version:

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

es-toolkit.dev

toss/es-toolkit

235 lines • 12.8 kB
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
//#region src/fp/pipe.d.ts /** * Returns `value` unchanged — the identity case of {@link pipe} with no functions. * * @param value - The initial value fed into the pipe. * @returns `value`, unchanged. */ declare function pipe<A>(value: A): A; /** * Pipes `value` through `fn1`, returning its result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @returns The result of `fn1`. */ declare function pipe<A, B>(value: A, fn1: (input: A) => B): B; /** * Pipes `value` left-to-right through `fn1` to `fn2`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @returns The result of `fn2` — the value returned by the last function. */ declare function pipe<A, B, C>(value: A, fn1: (input: A) => B, fn2: (input: B) => C): C; /** * Pipes `value` left-to-right through `fn1` to `fn3`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @returns The result of `fn3` — the value returned by the last function. */ declare function pipe<A, B, C, D>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D): D; /** * Pipes `value` left-to-right through `fn1` to `fn4`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @param fn4 - Applied to the result of `fn3`. * @returns The result of `fn4` — the value returned by the last function. */ declare function pipe<A, B, C, D, E>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D, fn4: (input: D) => E): E; /** * Pipes `value` left-to-right through `fn1` to `fn5`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @param fn4 - Applied to the result of `fn3`. * @param fn5 - Applied to the result of `fn4`. * @returns The result of `fn5` — the value returned by the last function. */ declare function pipe<A, B, C, D, E, F>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D, fn4: (input: D) => E, fn5: (input: E) => F): F; /** * Pipes `value` left-to-right through `fn1` to `fn6`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @param fn4 - Applied to the result of `fn3`. * @param fn5 - Applied to the result of `fn4`. * @param fn6 - Applied to the result of `fn5`. * @returns The result of `fn6` — the value returned by the last function. */ declare function pipe<A, B, C, D, E, F, G>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D, fn4: (input: D) => E, fn5: (input: E) => F, fn6: (input: F) => G): G; /** * Pipes `value` left-to-right through `fn1` to `fn7`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @param fn4 - Applied to the result of `fn3`. * @param fn5 - Applied to the result of `fn4`. * @param fn6 - Applied to the result of `fn5`. * @param fn7 - Applied to the result of `fn6`. * @returns The result of `fn7` — the value returned by the last function. */ declare function pipe<A, B, C, D, E, F, G, H>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D, fn4: (input: D) => E, fn5: (input: E) => F, fn6: (input: F) => G, fn7: (input: G) => H): H; /** * Pipes `value` left-to-right through `fn1` to `fn8`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @param fn4 - Applied to the result of `fn3`. * @param fn5 - Applied to the result of `fn4`. * @param fn6 - Applied to the result of `fn5`. * @param fn7 - Applied to the result of `fn6`. * @param fn8 - Applied to the result of `fn7`. * @returns The result of `fn8` — the value returned by the last function. */ declare function pipe<A, B, C, D, E, F, G, H, I>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D, fn4: (input: D) => E, fn5: (input: E) => F, fn6: (input: F) => G, fn7: (input: G) => H, fn8: (input: H) => I): I; /** * Pipes `value` left-to-right through `fn1` to `fn9`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @param fn4 - Applied to the result of `fn3`. * @param fn5 - Applied to the result of `fn4`. * @param fn6 - Applied to the result of `fn5`. * @param fn7 - Applied to the result of `fn6`. * @param fn8 - Applied to the result of `fn7`. * @param fn9 - Applied to the result of `fn8`. * @returns The result of `fn9` — the value returned by the last function. */ declare function pipe<A, B, C, D, E, F, G, H, I, J>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D, fn4: (input: D) => E, fn5: (input: E) => F, fn6: (input: F) => G, fn7: (input: G) => H, fn8: (input: H) => I, fn9: (input: I) => J): J; /** * Pipes `value` left-to-right through `fn1` to `fn10`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @param fn4 - Applied to the result of `fn3`. * @param fn5 - Applied to the result of `fn4`. * @param fn6 - Applied to the result of `fn5`. * @param fn7 - Applied to the result of `fn6`. * @param fn8 - Applied to the result of `fn7`. * @param fn9 - Applied to the result of `fn8`. * @param fn10 - Applied to the result of `fn9`. * @returns The result of `fn10` — the value returned by the last function. */ declare function pipe<A, B, C, D, E, F, G, H, I, J, K>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D, fn4: (input: D) => E, fn5: (input: E) => F, fn6: (input: F) => G, fn7: (input: G) => H, fn8: (input: H) => I, fn9: (input: I) => J, fn10: (input: J) => K): K; /** * Pipes `value` left-to-right through `fn1` to `fn11`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @param fn4 - Applied to the result of `fn3`. * @param fn5 - Applied to the result of `fn4`. * @param fn6 - Applied to the result of `fn5`. * @param fn7 - Applied to the result of `fn6`. * @param fn8 - Applied to the result of `fn7`. * @param fn9 - Applied to the result of `fn8`. * @param fn10 - Applied to the result of `fn9`. * @param fn11 - Applied to the result of `fn10`. * @returns The result of `fn11` — the value returned by the last function. */ declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D, fn4: (input: D) => E, fn5: (input: E) => F, fn6: (input: F) => G, fn7: (input: G) => H, fn8: (input: H) => I, fn9: (input: I) => J, fn10: (input: J) => K, fn11: (input: K) => L): L; /** * Pipes `value` left-to-right through `fn1` to `fn12`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @param fn4 - Applied to the result of `fn3`. * @param fn5 - Applied to the result of `fn4`. * @param fn6 - Applied to the result of `fn5`. * @param fn7 - Applied to the result of `fn6`. * @param fn8 - Applied to the result of `fn7`. * @param fn9 - Applied to the result of `fn8`. * @param fn10 - Applied to the result of `fn9`. * @param fn11 - Applied to the result of `fn10`. * @param fn12 - Applied to the result of `fn11`. * @returns The result of `fn12` — the value returned by the last function. */ declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D, fn4: (input: D) => E, fn5: (input: E) => F, fn6: (input: F) => G, fn7: (input: G) => H, fn8: (input: H) => I, fn9: (input: I) => J, fn10: (input: J) => K, fn11: (input: K) => L, fn12: (input: L) => M): M; /** * Pipes `value` left-to-right through `fn1` to `fn13`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @param fn4 - Applied to the result of `fn3`. * @param fn5 - Applied to the result of `fn4`. * @param fn6 - Applied to the result of `fn5`. * @param fn7 - Applied to the result of `fn6`. * @param fn8 - Applied to the result of `fn7`. * @param fn9 - Applied to the result of `fn8`. * @param fn10 - Applied to the result of `fn9`. * @param fn11 - Applied to the result of `fn10`. * @param fn12 - Applied to the result of `fn11`. * @param fn13 - Applied to the result of `fn12`. * @returns The result of `fn13` — the value returned by the last function. */ declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D, fn4: (input: D) => E, fn5: (input: E) => F, fn6: (input: F) => G, fn7: (input: G) => H, fn8: (input: H) => I, fn9: (input: I) => J, fn10: (input: J) => K, fn11: (input: K) => L, fn12: (input: L) => M, fn13: (input: M) => N): N; /** * Pipes `value` left-to-right through `fn1` to `fn14`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @param fn4 - Applied to the result of `fn3`. * @param fn5 - Applied to the result of `fn4`. * @param fn6 - Applied to the result of `fn5`. * @param fn7 - Applied to the result of `fn6`. * @param fn8 - Applied to the result of `fn7`. * @param fn9 - Applied to the result of `fn8`. * @param fn10 - Applied to the result of `fn9`. * @param fn11 - Applied to the result of `fn10`. * @param fn12 - Applied to the result of `fn11`. * @param fn13 - Applied to the result of `fn12`. * @param fn14 - Applied to the result of `fn13`. * @returns The result of `fn14` — the value returned by the last function. */ declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D, fn4: (input: D) => E, fn5: (input: E) => F, fn6: (input: F) => G, fn7: (input: G) => H, fn8: (input: H) => I, fn9: (input: I) => J, fn10: (input: J) => K, fn11: (input: K) => L, fn12: (input: L) => M, fn13: (input: M) => N, fn14: (input: N) => O): O; /** * Pipes `value` left-to-right through `fn1` to `fn15`, returning the final result. * * @param value - The initial value fed into the pipe. * @param fn1 - Applied to `value`. * @param fn2 - Applied to the result of `fn1`. * @param fn3 - Applied to the result of `fn2`. * @param fn4 - Applied to the result of `fn3`. * @param fn5 - Applied to the result of `fn4`. * @param fn6 - Applied to the result of `fn5`. * @param fn7 - Applied to the result of `fn6`. * @param fn8 - Applied to the result of `fn7`. * @param fn9 - Applied to the result of `fn8`. * @param fn10 - Applied to the result of `fn9`. * @param fn11 - Applied to the result of `fn10`. * @param fn12 - Applied to the result of `fn11`. * @param fn13 - Applied to the result of `fn12`. * @param fn14 - Applied to the result of `fn13`. * @param fn15 - Applied to the result of `fn14`. * @returns The result of `fn15` — the value returned by the last function. */ declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P>(value: A, fn1: (input: A) => B, fn2: (input: B) => C, fn3: (input: C) => D, fn4: (input: D) => E, fn5: (input: E) => F, fn6: (input: F) => G, fn7: (input: G) => H, fn8: (input: H) => I, fn9: (input: I) => J, fn10: (input: J) => K, fn11: (input: K) => L, fn12: (input: L) => M, fn13: (input: M) => N, fn14: (input: N) => O, fn15: (input: O) => P): P; //#endregion export { pipe };