UNPKG

63.5 kBTypeScriptView Raw
1import _ = require("../index");
2declare module "../index" {
3 interface LoDashStatic {
4 /**
5 * The opposite of _.before; this method creates a function that invokes func once it’s called n or more times.
6 *
7 * @param n The number of calls before func is invoked.
8 * @param func The function to restrict.
9 * @return Returns the new restricted function.
10 */
11 after<TFunc extends (...args: any[]) => any>(n: number, func: TFunc): TFunc;
12 }
13 interface Primitive<T> {
14 /**
15 * @see _.after
16 */
17 after<TFunc extends (...args: any[]) => any>(func: TFunc): Function<TFunc>;
18 }
19 interface PrimitiveChain<T> {
20 /**
21 * @see _.after
22 */
23 after<TFunc extends (...args: any[]) => any>(func: TFunc): FunctionChain<TFunc>;
24 }
25 interface LoDashStatic {
26 /**
27 * Creates a function that accepts up to n arguments ignoring any additional arguments.
28 *
29 * @param func The function to cap arguments for.
30 * @param n The arity cap.
31 * @returns Returns the new function.
32 */
33 ary(func: (...args: any[]) => any, n?: number): (...args: any[]) => any;
34 }
35 interface Function<T extends (...args: any) => any> {
36 /**
37 * @see _.ary
38 */
39 ary(n?: number): Function<(...args: any[]) => any>;
40 }
41 interface FunctionChain<T extends (...args: any) => any> {
42 /**
43 * @see _.ary
44 */
45 ary(n?: number): FunctionChain<(...args: any[]) => any>;
46 }
47 interface LoDashStatic {
48 /**
49 * Creates a function that invokes func, with the this binding and arguments of the created function, while
50 * it’s called less than n times. Subsequent calls to the created function return the result of the last func
51 * invocation.
52 *
53 * @param n The number of calls at which func is no longer invoked.
54 * @param func The function to restrict.
55 * @return Returns the new restricted function.
56 */
57 before<TFunc extends (...args: any[]) => any>(n: number, func: TFunc): TFunc;
58 }
59 interface Primitive<T> {
60 /**
61 * @see _.before
62 */
63 before<TFunc extends (...args: any[]) => any>(func: TFunc): Function<TFunc>;
64 }
65 interface PrimitiveChain<T> {
66 /**
67 * @see _.before
68 */
69 before<TFunc extends (...args: any[]) => any>(func: TFunc): FunctionChain<TFunc>;
70 }
71 interface FunctionBind {
72 /**
73 * @see _.placeholder
74 */
75 placeholder: __;
76 (func: (...args: any[]) => any, thisArg: any, ...partials: any[]): (...args: any[]) => any;
77 }
78 interface LoDashStatic {
79 /**
80 * Creates a function that invokes func with the this binding of thisArg and prepends any additional _.bind
81 * arguments to those provided to the bound function.
82 *
83 * The _.bind.placeholder value, which defaults to _ in monolithic builds, may be used as a placeholder for
84 * partially applied arguments.
85 *
86 * Note: Unlike native Function#bind this method does not set the "length" property of bound functions.
87 *
88 * @param func The function to bind.
89 * @param thisArg The this binding of func.
90 * @param partials The arguments to be partially applied.
91 * @return Returns the new bound function.
92 */
93 bind: FunctionBind;
94 }
95 interface LoDashImplicitWrapper<TValue> {
96 /**
97 * @see _.bind
98 */
99 bind(thisArg: any, ...partials: any[]): Function<(...args: any[]) => any>;
100 }
101 interface LoDashExplicitWrapper<TValue> {
102 /**
103 * @see _.bind
104 */
105 bind(thisArg: any, ...partials: any[]): FunctionChain<(...args: any[]) => any>;
106 }
107 interface FunctionBindKey {
108 placeholder: __;
109 (object: object, key: string, ...partials: any[]): (...args: any[]) => any;
110 }
111 interface LoDashStatic {
112 /**
113 * Creates a function that invokes the method at object[key] and prepends any additional _.bindKey arguments
114 * to those provided to the bound function.
115 *
116 * This method differs from _.bind by allowing bound functions to reference methods that may be redefined
117 * or don’t yet exist. See Peter Michaux’s article for more details.
118 *
119 * The _.bindKey.placeholder value, which defaults to _ in monolithic builds, may be used as a placeholder
120 * for partially applied arguments.
121 *
122 * @param object The object the method belongs to.
123 * @param key The key of the method.
124 * @param partials The arguments to be partially applied.
125 * @return Returns the new bound function.
126 */
127 bindKey: FunctionBindKey;
128 }
129 interface LoDashImplicitWrapper<TValue> {
130 /**
131 * @see _.bindKey
132 */
133 bindKey(key: string, ...partials: any[]): Function<(...args: any[]) => any>;
134 }
135 interface LoDashExplicitWrapper<TValue> {
136 /**
137 * @see _.bindKey
138 */
139 bindKey(key: string, ...partials: any[]): FunctionChain<(...args: any[]) => any>;
140 }
141 interface Curry {
142 <T1, R>(func: (t1: T1) => R, arity?: number): CurriedFunction1<T1, R>;
143 <T1, T2, R>(func: (t1: T1, t2: T2) => R, arity?: number): CurriedFunction2<T1, T2, R>;
144 <T1, T2, T3, R>(func: (t1: T1, t2: T2, t3: T3) => R, arity?: number): CurriedFunction3<T1, T2, T3, R>;
145 <T1, T2, T3, T4, R>(func: (t1: T1, t2: T2, t3: T3, t4: T4) => R, arity?: number): CurriedFunction4<T1, T2, T3, T4, R>;
146 <T1, T2, T3, T4, T5, R>(func: (t1: T1, t2: T2, t3: T3, t4: T4, t5: T5) => R, arity?: number): CurriedFunction5<T1, T2, T3, T4, T5, R>;
147 (func: (...args: any[]) => any, arity?: number): (...args: any[]) => any;
148 placeholder: __;
149 }
150 interface LoDashStatic {
151 curry: Curry;
152 }
153 interface CurriedFunction1<T1, R> {
154 (): CurriedFunction1<T1, R>;
155 (t1: T1): R;
156 }
157 interface CurriedFunction2<T1, T2, R> {
158 (): CurriedFunction2<T1, T2, R>;
159 (t1: T1): CurriedFunction1<T2, R>;
160 (t1: __, t2: T2): CurriedFunction1<T1, R>;
161 (t1: T1, t2: T2): R;
162 }
163 interface CurriedFunction3<T1, T2, T3, R> {
164 (): CurriedFunction3<T1, T2, T3, R>;
165 (t1: T1): CurriedFunction2<T2, T3, R>;
166 (t1: __, t2: T2): CurriedFunction2<T1, T3, R>;
167 (t1: T1, t2: T2): CurriedFunction1<T3, R>;
168 (t1: __, t2: __, t3: T3): CurriedFunction2<T1, T2, R>;
169 (t1: T1, t2: __, t3: T3): CurriedFunction1<T2, R>;
170 (t1: __, t2: T2, t3: T3): CurriedFunction1<T1, R>;
171 (t1: T1, t2: T2, t3: T3): R;
172 }
173 interface CurriedFunction4<T1, T2, T3, T4, R> {
174 (): CurriedFunction4<T1, T2, T3, T4, R>;
175 (t1: T1): CurriedFunction3<T2, T3, T4, R>;
176 (t1: __, t2: T2): CurriedFunction3<T1, T3, T4, R>;
177 (t1: T1, t2: T2): CurriedFunction2<T3, T4, R>;
178 (t1: __, t2: __, t3: T3): CurriedFunction3<T1, T2, T4, R>;
179 (t1: __, t2: __, t3: T3): CurriedFunction2<T2, T4, R>;
180 (t1: __, t2: T2, t3: T3): CurriedFunction2<T1, T4, R>;
181 (t1: T1, t2: T2, t3: T3): CurriedFunction1<T4, R>;
182 (t1: __, t2: __, t3: __, t4: T4): CurriedFunction3<T1, T2, T3, R>;
183 (t1: T1, t2: __, t3: __, t4: T4): CurriedFunction2<T2, T3, R>;
184 (t1: __, t2: T2, t3: __, t4: T4): CurriedFunction2<T1, T3, R>;
185 (t1: __, t2: __, t3: T3, t4: T4): CurriedFunction2<T1, T2, R>;
186 (t1: T1, t2: T2, t3: __, t4: T4): CurriedFunction1<T3, R>;
187 (t1: T1, t2: __, t3: T3, t4: T4): CurriedFunction1<T2, R>;
188 (t1: __, t2: T2, t3: T3, t4: T4): CurriedFunction1<T1, R>;
189 (t1: T1, t2: T2, t3: T3, t4: T4): R;
190 }
191 interface CurriedFunction5<T1, T2, T3, T4, T5, R> {
192 (): CurriedFunction5<T1, T2, T3, T4, T5, R>;
193 (t1: T1): CurriedFunction4<T2, T3, T4, T5, R>;
194 (t1: __, t2: T2): CurriedFunction4<T1, T3, T4, T5, R>;
195 (t1: T1, t2: T2): CurriedFunction3<T3, T4, T5, R>;
196 (t1: __, t2: __, t3: T3): CurriedFunction4<T1, T2, T4, T5, R>;
197 (t1: T1, t2: __, t3: T3): CurriedFunction3<T2, T4, T5, R>;
198 (t1: __, t2: T2, t3: T3): CurriedFunction3<T1, T4, T5, R>;
199 (t1: T1, t2: T2, t3: T3): CurriedFunction2<T4, T5, R>;
200 (t1: __, t2: __, t3: __, t4: T4): CurriedFunction4<T1, T2, T3, T5, R>;
201 (t1: T1, t2: __, t3: __, t4: T4): CurriedFunction3<T2, T3, T5, R>;
202 (t1: __, t2: T2, t3: __, t4: T4): CurriedFunction3<T1, T3, T5, R>;
203 (t1: __, t2: __, t3: T3, t4: T4): CurriedFunction3<T1, T2, T5, R>;
204 (t1: T1, t2: T2, t3: __, t4: T4): CurriedFunction2<T3, T5, R>;
205 (t1: T1, t2: __, t3: T3, t4: T4): CurriedFunction2<T2, T5, R>;
206 (t1: __, t2: T2, t3: T3, t4: T4): CurriedFunction2<T1, T5, R>;
207 (t1: T1, t2: T2, t3: T3, t4: T4): CurriedFunction1<T5, R>;
208 (t1: __, t2: __, t3: __, t4: __, t5: T5): CurriedFunction4<T1, T2, T3, T4, R>;
209 (t1: T1, t2: __, t3: __, t4: __, t5: T5): CurriedFunction3<T2, T3, T4, R>;
210 (t1: __, t2: T2, t3: __, t4: __, t5: T5): CurriedFunction3<T1, T3, T4, R>;
211 (t1: __, t2: __, t3: T3, t4: __, t5: T5): CurriedFunction3<T1, T2, T4, R>;
212 (t1: __, t2: __, t3: __, t4: T4, t5: T5): CurriedFunction3<T1, T2, T3, R>;
213 (t1: T1, t2: T2, t3: __, t4: __, t5: T5): CurriedFunction2<T3, T4, R>;
214 (t1: T1, t2: __, t3: T3, t4: __, t5: T5): CurriedFunction2<T2, T4, R>;
215 (t1: T1, t2: __, t3: __, t4: T4, t5: T5): CurriedFunction2<T2, T3, R>;
216 (t1: __, t2: T2, t3: T3, t4: __, t5: T5): CurriedFunction2<T1, T4, R>;
217 (t1: __, t2: T2, t3: __, t4: T4, t5: T5): CurriedFunction2<T1, T3, R>;
218 (t1: __, t2: __, t3: T3, t4: T4, t5: T5): CurriedFunction2<T1, T2, R>;
219 (t1: T1, t2: T2, t3: T3, t4: __, t5: T5): CurriedFunction1<T4, R>;
220 (t1: T1, t2: T2, t3: __, t4: T4, t5: T5): CurriedFunction1<T3, R>;
221 (t1: T1, t2: __, t3: T3, t4: T4, t5: T5): CurriedFunction1<T2, R>;
222 (t1: __, t2: T2, t3: T3, t4: T4, t5: T5): CurriedFunction1<T1, R>;
223 (t1: T1, t2: T2, t3: T3, t4: T4, t5: T5): R;
224 }
225 interface RightCurriedFunction1<T1, R> {
226 (): RightCurriedFunction1<T1, R>;
227 (t1: T1): R;
228 }
229 interface RightCurriedFunction2<T1, T2, R> {
230 (): RightCurriedFunction2<T1, T2, R>;
231 (t2: T2): RightCurriedFunction1<T1, R>;
232 (t1: T1, t2: __): RightCurriedFunction1<T2, R>;
233 (t1: T1, t2: T2): R;
234 }
235 interface RightCurriedFunction3<T1, T2, T3, R> {
236 (): RightCurriedFunction3<T1, T2, T3, R>;
237 (t3: T3): RightCurriedFunction2<T1, T2, R>;
238 (t2: T2, t3: __): RightCurriedFunction2<T1, T3, R>;
239 (t2: T2, t3: T3): RightCurriedFunction1<T1, R>;
240 (t1: T1, t2: __, t3: __): RightCurriedFunction2<T2, T3, R>;
241 (t1: T1, t2: T2, t3: __): RightCurriedFunction1<T3, R>;
242 (t1: T1, t2: __, t3: T3): RightCurriedFunction1<T2, R>;
243 (t1: T1, t2: T2, t3: T3): R;
244 }
245 interface RightCurriedFunction4<T1, T2, T3, T4, R> {
246 (): RightCurriedFunction4<T1, T2, T3, T4, R>;
247 (t4: T4): RightCurriedFunction3<T1, T2, T3, R>;
248 (t3: T3, t4: __): RightCurriedFunction3<T1, T2, T4, R>;
249 (t3: T3, t4: T4): RightCurriedFunction2<T1, T2, R>;
250 (t2: T2, t3: __, t4: __): RightCurriedFunction3<T1, T3, T4, R>;
251 (t2: T2, t3: T3, t4: __): RightCurriedFunction2<T1, T4, R>;
252 (t2: T2, t3: __, t4: T4): RightCurriedFunction2<T1, T3, R>;
253 (t2: T2, t3: T3, t4: T4): RightCurriedFunction1<T1, R>;
254 (t1: T1, t2: __, t3: __, t4: __): RightCurriedFunction3<T2, T3, T4, R>;
255 (t1: T1, t2: T2, t3: __, t4: __): RightCurriedFunction2<T3, T4, R>;
256 (t1: T1, t2: __, t3: T3, t4: __): RightCurriedFunction2<T2, T4, R>;
257 (t1: T1, t2: __, t3: __, t4: T4): RightCurriedFunction2<T2, T3, R>;
258 (t1: T1, t2: T2, t3: T3, t4: __): RightCurriedFunction1<T4, R>;
259 (t1: T1, t2: T2, t3: __, t4: T4): RightCurriedFunction1<T3, R>;
260 (t1: T1, t2: __, t3: T3, t4: T4): RightCurriedFunction1<T2, R>;
261 (t1: T1, t2: T2, t3: T3, t4: T4): R;
262 }
263 interface RightCurriedFunction5<T1, T2, T3, T4, T5, R> {
264 (): RightCurriedFunction5<T1, T2, T3, T4, T5, R>;
265 (t5: T5): RightCurriedFunction4<T1, T2, T3, T4, R>;
266 (t4: T4, t5: __): RightCurriedFunction4<T1, T2, T3, T5, R>;
267 (t4: T4, t5: T5): RightCurriedFunction3<T1, T2, T3, R>;
268 (t3: T3, t4: __, t5: __): RightCurriedFunction4<T1, T2, T4, T5, R>;
269 (t3: T3, t4: T4, t5: __): RightCurriedFunction3<T1, T2, T5, R>;
270 (t3: T3, t4: __, t5: T5): RightCurriedFunction3<T1, T2, T4, R>;
271 (t3: T3, t4: T4, t5: T5): RightCurriedFunction2<T1, T2, R>;
272 (t2: T2, t3: __, t4: __, t5: __): RightCurriedFunction4<T1, T3, T4, T5, R>;
273 (t2: T2, t3: T3, t4: __, t5: __): RightCurriedFunction3<T1, T4, T5, R>;
274 (t2: T2, t3: __, t4: T4, t5: __): RightCurriedFunction3<T1, T3, T5, R>;
275 (t2: T2, t3: __, t4: __, t5: T5): RightCurriedFunction3<T1, T3, T4, R>;
276 (t2: T2, t3: T3, t4: T4, t5: __): RightCurriedFunction2<T1, T5, R>;
277 (t2: T2, t3: T3, t4: __, t5: T5): RightCurriedFunction2<T1, T4, R>;
278 (t2: T2, t3: __, t4: T4, t5: T5): RightCurriedFunction2<T1, T3, R>;
279 (t2: T2, t3: T3, t4: T4, t5: T5): RightCurriedFunction1<T1, R>;
280 (t1: T1, t2: __, t3: __, t4: __, t5: __): RightCurriedFunction4<T2, T3, T4, T5, R>;
281 (t1: T1, t2: T2, t3: __, t4: __, t5: __): RightCurriedFunction3<T3, T4, T5, R>;
282 (t1: T1, t2: __, t3: T3, t4: __, t5: __): RightCurriedFunction3<T2, T4, T5, R>;
283 (t1: T1, t2: __, t3: __, t4: T4, t5: __): RightCurriedFunction3<T2, T3, T5, R>;
284 (t1: T1, t2: __, t3: __, t4: __, t5: T5): RightCurriedFunction3<T2, T3, T4, R>;
285 (t1: T1, t2: T2, t3: T3, t4: __, t5: __): RightCurriedFunction2<T4, T5, R>;
286 (t1: T1, t2: T2, t3: __, t4: T4, t5: __): RightCurriedFunction2<T3, T5, R>;
287 (t1: T1, t2: T2, t3: __, t4: __, t5: T5): RightCurriedFunction2<T3, T4, R>;
288 (t1: T1, t2: __, t3: T3, t4: T4, t5: __): RightCurriedFunction2<T2, T5, R>;
289 (t1: T1, t2: __, t3: T3, t4: __, t5: T5): RightCurriedFunction2<T2, T4, R>;
290 (t1: T1, t2: __, t3: __, t4: T4, t5: T5): RightCurriedFunction2<T2, T3, R>;
291 (t1: T1, t2: T2, t3: T3, t4: T4, t5: __): RightCurriedFunction1<T5, R>;
292 (t1: T1, t2: T2, t3: T3, t4: __, t5: T5): RightCurriedFunction1<T4, R>;
293 (t1: T1, t2: T2, t3: __, t4: T4, t5: T5): RightCurriedFunction1<T3, R>;
294 (t1: T1, t2: __, t3: T3, t4: T4, t5: T5): RightCurriedFunction1<T2, R>;
295 (t1: T1, t2: T2, t3: T3, t4: T4, t5: T5): R;
296 }
297 interface Function<T extends (...args: any) => any> {
298 /**
299 * @see _.curry
300 */
301 curry(arity?: number):
302 T extends (arg1: infer T1) => infer R ? Function<CurriedFunction1<T1, R>> :
303 T extends (arg1: infer T1, arg2: infer T2) => infer R ? Function<CurriedFunction2<T1, T2, R>> :
304 T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3) => infer R ? Function<CurriedFunction3<T1, T2, T3, R>> :
305 T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4) => infer R ? Function<CurriedFunction4<T1, T2, T3, T4, R>> :
306 T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4, arg5: infer T5) => infer R ? Function<CurriedFunction5<T1, T2, T3, T4, T5, R>> :
307 Function<(...args: any[]) => any>;
308 }
309 interface FunctionChain<T extends (...args: any) => any> {
310 /**
311 * @see _.curry
312 */
313 curry(arity?: number):
314 T extends (arg1: infer T1) => infer R ? FunctionChain<CurriedFunction1<T1, R>> :
315 T extends (arg1: infer T1, arg2: infer T2) => infer R ? FunctionChain<CurriedFunction2<T1, T2, R>> :
316 T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3) => infer R ? FunctionChain<CurriedFunction3<T1, T2, T3, R>> :
317 T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4) => infer R ? FunctionChain<CurriedFunction4<T1, T2, T3, T4, R>> :
318 T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4, arg5: infer T5) => infer R ? FunctionChain<CurriedFunction5<T1, T2, T3, T4, T5, R>> :
319 FunctionChain<(...args: any[]) => any>;
320 }
321 interface CurryRight {
322 <T1, R>(func: (t1: T1) => R, arity?: number): RightCurriedFunction1<T1, R>;
323 <T1, T2, R>(func: (t1: T1, t2: T2) => R, arity?: number): RightCurriedFunction2<T1, T2, R>;
324 <T1, T2, T3, R>(func: (t1: T1, t2: T2, t3: T3) => R, arity?: number): RightCurriedFunction3<T1, T2, T3, R>;
325 <T1, T2, T3, T4, R>(func: (t1: T1, t2: T2, t3: T3, t4: T4) => R, arity?: number): RightCurriedFunction4<T1, T2, T3, T4, R>;
326 <T1, T2, T3, T4, T5, R>(func: (t1: T1, t2: T2, t3: T3, t4: T4, t5: T5) => R, arity?: number): RightCurriedFunction5<T1, T2, T3, T4, T5, R>;
327 (func: (...args: any[]) => any, arity?: number): (...args: any[]) => any;
328 placeholder: __;
329 }
330 interface LoDashStatic {
331 curryRight: CurryRight;
332 }
333 interface Function<T extends (...args: any) => any> {
334 /**
335 * @see _.curryRight
336 */
337 curryRight(arity?: number):
338 T extends (arg1: infer T1) => infer R ? Function<RightCurriedFunction1<T1, R>> :
339 T extends (arg1: infer T1, arg2: infer T2) => infer R ? Function<RightCurriedFunction2<T1, T2, R>> :
340 T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3) => infer R ? Function<RightCurriedFunction3<T1, T2, T3, R>> :
341 T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4) => infer R ? Function<RightCurriedFunction4<T1, T2, T3, T4, R>> :
342 T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4, arg5: infer T5) => infer R ? Function<RightCurriedFunction5<T1, T2, T3, T4, T5, R>> :
343 Function<(...args: any[]) => any>;
344 }
345 interface FunctionChain<T extends (...args: any) => any> {
346 /**
347 * @see _.curryRight
348 */
349 curryRight(arity?: number):
350 T extends (arg1: infer T1) => infer R ? FunctionChain<RightCurriedFunction1<T1, R>> :
351 T extends (arg1: infer T1, arg2: infer T2) => infer R ? FunctionChain<RightCurriedFunction2<T1, T2, R>> :
352 T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3) => infer R ? FunctionChain<RightCurriedFunction3<T1, T2, T3, R>> :
353 T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4) => infer R ? FunctionChain<RightCurriedFunction4<T1, T2, T3, T4, R>> :
354 T extends (arg1: infer T1, arg2: infer T2, arg3: infer T3, arg4: infer T4, arg5: infer T5) => infer R ? FunctionChain<RightCurriedFunction5<T1, T2, T3, T4, T5, R>> :
355 FunctionChain<(...args: any[]) => any>;
356 }
357 interface DebounceSettings {
358 /**
359 * @see _.leading
360 */
361 leading?: boolean | undefined;
362 /**
363 * @see _.maxWait
364 */
365 maxWait?: number | undefined;
366 /**
367 * @see _.trailing
368 */
369 trailing?: boolean | undefined;
370 }
371 interface DebounceSettingsLeading extends DebounceSettings {
372 leading: true;
373 }
374 interface DebouncedFunc<T extends (...args: any[]) => any> {
375 /**
376 * Call the original function, but applying the debounce rules.
377 *
378 * If the debounced function can be run immediately, this calls it and returns its return
379 * value.
380 *
381 * Otherwise, it returns the return value of the last invocation, or undefined if the debounced
382 * function was not invoked yet.
383 */
384 (...args: Parameters<T>): ReturnType<T> | undefined;
385
386 /**
387 * Throw away any pending invocation of the debounced function.
388 */
389 cancel(): void;
390
391 /**
392 * If there is a pending invocation of the debounced function, invoke it immediately and return
393 * its return value.
394 *
395 * Otherwise, return the value from the last invocation, or undefined if the debounced function
396 * was never invoked.
397 */
398 flush(): ReturnType<T> | undefined;
399 }
400 interface DebouncedFuncLeading<T extends (...args: any[]) => any> extends DebouncedFunc<T> {
401 (...args: Parameters<T>): ReturnType<T>;
402 flush(): ReturnType<T>;
403 }
404 interface LoDashStatic {
405 /**
406 * Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since
407 * the last time the debounced function was invoked. The debounced function comes with a cancel method to
408 * cancel delayed invocations and a flush method to immediately invoke them. Provide an options object to
409 * indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent
410 * calls to the debounced function return the result of the last func invocation.
411 *
412 * Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only
413 * if the the debounced function is invoked more than once during the wait timeout.
414 *
415 * See David Corbacho’s article for details over the differences between _.debounce and _.throttle.
416 *
417 * @param func The function to debounce.
418 * @param wait The number of milliseconds to delay.
419 * @param options The options object.
420 * @param options.leading Specify invoking on the leading edge of the timeout.
421 * @param options.maxWait The maximum time func is allowed to be delayed before it’s invoked.
422 * @param options.trailing Specify invoking on the trailing edge of the timeout.
423 * @return Returns the new debounced function.
424 */
425 debounce<T extends (...args: any) => any>(func: T, wait: number | undefined, options: DebounceSettingsLeading): DebouncedFuncLeading<T>;
426 debounce<T extends (...args: any) => any>(func: T, wait?: number, options?: DebounceSettings): DebouncedFunc<T>;
427 }
428 interface Function<T extends (...args: any) => any> {
429 /**
430 * @see _.debounce
431 */
432 debounce(
433 wait: number | undefined,
434 options: DebounceSettingsLeading
435 ): T extends (...args: any[]) => any ? Function<DebouncedFuncLeading<T>> : never;
436 debounce(
437 wait?: number,
438 options?: DebounceSettings
439 ): T extends (...args: any[]) => any ? Function<DebouncedFunc<T>> : never;
440 }
441 interface FunctionChain<T extends (...args: any) => any> {
442 /**
443 * @see _.debounce
444 */
445 debounce(
446 wait: number | undefined,
447 options: DebounceSettingsLeading
448 ): T extends (...args: any[]) => any ? FunctionChain<DebouncedFuncLeading<T>> : never;
449 debounce(
450 wait?: number,
451 options?: DebounceSettings
452 ): T extends (...args: any[]) => any ? FunctionChain<DebouncedFunc<T>> : never;
453 }
454 interface LoDashStatic {
455 /**
456 * Defers invoking the func until the current call stack has cleared. Any additional arguments are provided to
457 * func when it’s invoked.
458 *
459 * @param func The function to defer.
460 * @param args The arguments to invoke the function with.
461 * @return Returns the timer id.
462 */
463 defer(func: (...args: any[]) => any, ...args: any[]): number;
464 }
465 interface LoDashImplicitWrapper<TValue> {
466 /**
467 * @see _.defer
468 */
469 defer(...args: any[]): Primitive<number>;
470 }
471 interface LoDashExplicitWrapper<TValue> {
472 /**
473 * @see _.defer
474 */
475 defer(...args: any[]): PrimitiveChain<number>;
476 }
477 interface LoDashStatic {
478 /**
479 * Invokes func after wait milliseconds. Any additional arguments are provided to func when it’s invoked.
480 *
481 * @param func The function to delay.
482 * @param wait The number of milliseconds to delay invocation.
483 * @param args The arguments to invoke the function with.
484 * @return Returns the timer id.
485 */
486 delay(func: (...args: any[]) => any, wait: number, ...args: any[]): number;
487 }
488 interface LoDashImplicitWrapper<TValue> {
489 /**
490 * @see _.delay
491 */
492 delay(wait: number, ...args: any[]): Primitive<number>;
493 }
494 interface LoDashExplicitWrapper<TValue> {
495 /**
496 * @see _.delay
497 */
498 delay(wait: number, ...args: any[]): PrimitiveChain<number>;
499 }
500 interface LoDashStatic {
501 /**
502 * Creates a function that invokes `func` with arguments reversed.
503 *
504 * @category Function
505 * @param func The function to flip arguments for.
506 * @returns Returns the new function.
507 * @example
508 *
509 * var flipped = _.flip(function() {
510 * return _.toArray(arguments);
511 * });
512 *
513 * flipped('a', 'b', 'c', 'd');
514 * // => ['d', 'c', 'b', 'a']
515 */
516 flip<T extends (...args: any) => any>(func: T): T;
517 }
518 interface Function<T extends (...args: any) => any> {
519 /**
520 * @see _.flip
521 */
522 flip(): this;
523 }
524 interface FunctionChain<T extends (...args: any) => any> {
525 /**
526 * @see _.flip
527 */
528 flip(): this;
529 }
530 interface MemoizedFunction {
531 /**
532 * @see _.cache
533 */
534 cache: MapCache;
535 }
536 interface LoDashStatic {
537 /**
538 * Creates a function that memoizes the result of func. If resolver is provided it determines the cache key for
539 * storing the result based on the arguments provided to the memoized function. By default, the first argument
540 * provided to the memoized function is coerced to a string and used as the cache key. The func is invoked with
541 * the this binding of the memoized function.
542 *
543 * @param func The function to have its output memoized.
544 * @param resolver The function to resolve the cache key.
545 * @return Returns the new memoizing function.
546 */
547 memoize: {
548 <T extends (...args: any) => any>(func: T, resolver?: (...args: Parameters<T>) => any): T & MemoizedFunction;
549 Cache: MapCacheConstructor;
550 };
551 }
552 interface Function<T extends (...args: any) => any> {
553 /**
554 * @see _.memoize
555 */
556 memoize(resolver?: (...args: any[]) => any): Function<T & MemoizedFunction>;
557 }
558 interface FunctionChain<T extends (...args: any) => any> {
559 /**
560 * @see _.memoize
561 */
562 memoize(resolver?: (...args: any[]) => any): FunctionChain<T & MemoizedFunction>;
563 }
564 interface LoDashStatic {
565 /**
566 * Creates a function that negates the result of the predicate func. The func predicate is invoked with
567 * the this binding and arguments of the created function.
568 *
569 * @param predicate The predicate to negate.
570 * @return Returns the new function.
571 */
572 negate<T extends any[]>(predicate: (...args: T) => boolean): (...args: T) => boolean;
573 }
574 interface Function<T extends (...args: any) => any> {
575 /**
576 * @see _.negate
577 */
578 negate(): Function<(...args: Parameters<T>) => boolean>;
579 }
580 interface FunctionChain<T extends (...args: any) => any> {
581 /**
582 * @see _.negate
583 */
584 negate(): FunctionChain<(...args: Parameters<T>) => boolean>;
585 }
586 interface LoDashStatic {
587 /**
588 * Creates a function that is restricted to invoking func once. Repeat calls to the function return the value
589 * of the first call. The func is invoked with the this binding and arguments of the created function.
590 *
591 * @param func The function to restrict.
592 * @return Returns the new restricted function.
593 */
594 once<T extends (...args: any) => any>(func: T): T;
595 }
596 interface Function<T extends (...args: any) => any> {
597 /**
598 * @see _.once
599 */
600 once(): Function<T>;
601 }
602 interface FunctionChain<T extends (...args: any) => any> {
603 /**
604 * @see _.once
605 */
606 once(): FunctionChain<T>;
607 }
608 interface LoDashStatic {
609 /**
610 * Creates a function that runs each argument through a corresponding transform function.
611 *
612 * @param func The function to wrap.
613 * @param transforms The functions to transform arguments, specified as individual functions or arrays
614 * of functions.
615 * @return Returns the new function.
616 */
617 overArgs(func: (...args: any[]) => any, ...transforms: Array<Many<(...args: any[]) => any>>): (...args: any[]) => any;
618 }
619 interface Function<T extends (...args: any) => any> {
620 /**
621 * @see _.overArgs
622 */
623 overArgs(...transforms: Array<Many<(...args: any[]) => any>>): Function<(...args: any[]) => any>;
624 }
625 interface FunctionChain<T extends (...args: any) => any> {
626 /**
627 * @see _.overArgs
628 */
629 overArgs(...transforms: Array<Many<(...args: any[]) => any>>): FunctionChain<(...args: any[]) => any>;
630 }
631 interface LoDashStatic {
632 /**
633 * Creates a function that, when called, invokes func with any additional partial arguments
634 * prepended to those provided to the new function. This method is similar to _.bind except
635 * it does not alter the this binding.
636 * @param func The function to partially apply arguments to.
637 * @param args Arguments to be partially applied.
638 * @return The new partially applied function.
639 */
640 partial: Partial;
641 }
642 type __ = LoDashStatic;
643 type Function0<R> = () => R;
644 type Function1<T1, R> = (t1: T1) => R;
645 type Function2<T1, T2, R> = (t1: T1, t2: T2) => R;
646 type Function3<T1, T2, T3, R> = (t1: T1, t2: T2, t3: T3) => R;
647 type Function4<T1, T2, T3, T4, R> = (t1: T1, t2: T2, t3: T3, t4: T4) => R;
648 interface Partial {
649 <T1, T2, R>(func: Function2<T1, T2, R>, plc1: __, arg2: T2): Function1<T1, R>;
650 <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, plc1: __, arg2: T2): Function2<T1, T3, R>;
651 <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, plc1: __, plc2: __, arg3: T3): Function2<T1, T2, R>;
652 <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, plc2: __, arg3: T3): Function1<T2, R>;
653 <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, plc1: __, arg2: T2, arg3: T3): Function1<T1, R>;
654 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: __, arg2: T2): Function3<T1, T3, T4, R>;
655 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: __, plc2: __, arg3: T3): Function3<T1, T2, T4, R>;
656 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, arg3: T3): Function2<T2, T4, R>;
657 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: __, arg2: T2, arg3: T3): Function2<T1, T4, R>;
658 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3): Function1<T4, R>;
659 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: __, plc2: __, plc3: __, arg4: T4): Function3<T1, T2, T3, R>;
660 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, plc3: __, arg4: T4): Function2<T2, T3, R>;
661 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: __, arg2: T2, plc3: __, arg4: T4): Function2<T1, T3, R>;
662 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, plc3: __, arg4: T4): Function1<T3, R>;
663 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: __, plc2: __, arg3: T3, arg4: T4): Function2<T1, T2, R>;
664 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, arg3: T3, arg4: T4): Function1<T2, R>;
665 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: __, arg2: T2, arg3: T3, arg4: T4): Function1<T1, R>;
666 <TS extends any[], R>(func: (...ts: TS) => R): (...ts: TS) => R;
667 <TS extends any[], T1, R>(func: (t1: T1, ...ts: TS) => R, arg1: T1): (...ts: TS) => R;
668 <TS extends any[], T1, T2, R>(func: (t1: T1, t2: T2, ...ts: TS) => R, t1: T1, t2: T2): (...ts: TS) => R;
669 <TS extends any[], T1, T2, T3, R>(func: (t1: T1, t2: T2, t3: T3, ...ts: TS) => R, t1: T1, t2: T2, t3: T3): (...ts: TS) => R;
670 <TS extends any[], T1, T2, T3, T4, R>(func: (t1: T1, t2: T2, t3: T3, t4: T4, ...ts: TS) => R, t1: T1, t2: T2, t3: T3, t4: T4): (...ts: TS) => R;
671 placeholder: __;
672 }
673 interface Function<T extends (...args: any) => any> {
674 /**
675 * @see _.partial
676 */
677 partial<T2>(plc1: __, arg2: T2): Function<
678 T extends Function2<infer T1, T2, infer R> ? Function1<T1, R> :
679 T extends Function3<infer T1, T2, infer T3, infer R> ? Function2<T1, T3, R> :
680 T extends Function4<infer T1, T2, infer T3, infer T4, infer R> ? Function3<T1, T3, T4, R> :
681 any
682 >;
683 /**
684 * @see _.partial
685 */
686 partial<T3>(plc1: __, plc2: __, arg3: T3): Function<
687 T extends Function3<infer T1, infer T2, T3, infer R> ? Function2<T1, T2, R> :
688 T extends Function4<infer T1, infer T2, T3, infer T4, infer R> ? Function3<T1, T2, T4, R> :
689 any
690 >;
691 /**
692 * @see _.partial
693 */
694 partial<T1, T3>(arg1: T1, plc2: __, arg3: T3): Function<
695 T extends Function3<T1, infer T2, T3, infer R> ? Function1<T2, R> :
696 T extends Function4<T1, infer T2, T3, infer T4, infer R> ? Function2<T2, T4, R> :
697 any
698 >;
699 /**
700 * @see _.partial
701 */
702 partial<T2, T3>(plc1: __, arg2: T2, arg3: T3): Function<
703 T extends Function3<infer T1, T2, T3, infer R> ? Function1<T1, R> :
704 T extends Function4<infer T1, T2, T3, infer T4, infer R> ? Function2<T1, T4, R> :
705 any
706 >;
707 /**
708 * @see _.partial
709 */
710 partial<T3>(plc1: __, plc2: __, arg3: T3): Function<
711 T extends Function4<infer T1, infer T2, T3, infer T4, infer R> ? Function3<T1, T2, T4, R> :
712 any
713 >;
714 /**
715 * @see _.partial
716 */
717 partial<T1, T4>(arg1: T1, plc2: __, plc3: __, arg4: T4): Function<
718 T extends Function4<T1, infer T2, infer T3, T4, infer R> ? Function2<T2, T3, R> :
719 any
720 >;
721 /**
722 * @see _.partial
723 */
724 partial<T2, T4>(plc1: __, arg2: T2, plc3: __, arg4: T4): Function<
725 T extends Function4<infer T1, T2, infer T3, T4, infer R> ? Function2<T1, T3, R> :
726 any
727 >;
728 /**
729 * @see _.partial
730 */
731 partial<T1, T2, T4>(arg1: T1, arg2: T2, plc3: __, arg4: T4): Function<
732 T extends Function4<T1, T2, infer T3, T4, infer R> ? Function1<T3, R> :
733 any
734 >;
735 /**
736 * @see _.partial
737 */
738 partial<T3, T4>(plc1: __, plc2: __, arg3: T3, arg4: T4): Function<
739 T extends Function4<infer T1, infer T2, T3, T4, infer R> ? Function2<T1, T2, R> :
740 any
741 >;
742 /**
743 * @see _.partial
744 */
745 partial<T1, T3, T4>(arg1: T1, plc2: __, arg3: T3, arg4: T4): Function<
746 T extends Function4<T1, infer T2, T3, T4, infer R> ? Function1<T2, R> :
747 any
748 >;
749 /**
750 * @see _.partial
751 */
752 partial<T2, T3, T4>(plc1: __, arg2: T2, arg3: T3, arg4: T4): Function<
753 T extends Function4<infer T1, T2, T3, T4, infer R> ? Function1<T1, R> :
754 any
755 >;
756 /**
757 * @see _.partial
758 */
759 partial<T1, T2, T3, T4>(arg1: T1, arg2: T2, arg3: T3, arg4: T4): Function<
760 T extends (t1: T1, t2: T2, t3: T3, t4: T4, ...ts: infer TS) => infer R ? (...ts: TS) => R :
761 any
762 >;
763 /**
764 * @see _.partial
765 */
766 partial<T1, T2, T3>(arg1: T1, arg2: T2, arg3: T3): Function<
767 T extends (t1: T1, t2: T2, t3: T3, ...ts: infer TS) => infer R ? (...ts: TS) => R :
768 any
769 >;
770 /**
771 * @see _.partial
772 */
773 partial<T1, T2>(arg1: T1, arg2: T2): Function<
774 T extends (t1: T1, t2: T2, ...ts: infer TS) => infer R ? (...ts: TS) => R :
775 any
776 >;
777 /**
778 * @see _.partial
779 */
780 partial<T1>(arg1: T1): Function<
781 T extends (t1: T1, ...ts: infer TS) => infer R ? (...ts: TS) => R :
782 any
783 >;
784 /**
785 * @see _.partial
786 */
787 partial(): Function<T extends (...ts: any[]) => any ? T : any>;
788 }
789 interface FunctionChain<T extends (...args: any) => any> {
790 /**
791 * @see _.partial
792 */
793 partial<T2>(plc1: __, arg2: T2): FunctionChain<
794 T extends Function2<infer T1, T2, infer R> ? Function1<T1, R> :
795 T extends Function3<infer T1, T2, infer T3, infer R> ? Function2<T1, T3, R> :
796 T extends Function4<infer T1, T2, infer T3, infer T4, infer R> ? Function3<T1, T3, T4, R> :
797 any
798 >;
799 /**
800 * @see _.partial
801 */
802 partial<T3>(plc1: __, plc2: __, arg3: T3): FunctionChain<
803 T extends Function3<infer T1, infer T2, T3, infer R> ? Function2<T1, T2, R> :
804 T extends Function4<infer T1, infer T2, T3, infer T4, infer R> ? Function3<T1, T2, T4, R> :
805 any
806 >;
807 /**
808 * @see _.partial
809 */
810 partial<T1, T3>(arg1: T1, plc2: __, arg3: T3): FunctionChain<
811 T extends Function3<T1, infer T2, T3, infer R> ? Function1<T2, R> :
812 T extends Function4<T1, infer T2, T3, infer T4, infer R> ? Function2<T2, T4, R> :
813 any
814 >;
815 /**
816 * @see _.partial
817 */
818 partial<T2, T3>(plc1: __, arg2: T2, arg3: T3): FunctionChain<
819 T extends Function3<infer T1, T2, T3, infer R> ? Function1<T1, R> :
820 T extends Function4<infer T1, T2, T3, infer T4, infer R> ? Function2<T1, T4, R> :
821 any
822 >;
823 /**
824 * @see _.partial
825 */
826 partial<T3>(plc1: __, plc2: __, arg3: T3): FunctionChain<
827 T extends Function4<infer T1, infer T2, T3, infer T4, infer R> ? Function3<T1, T2, T4, R> :
828 any
829 >;
830 /**
831 * @see _.partial
832 */
833 partial<T1, T4>(arg1: T1, plc2: __, plc3: __, arg4: T4): FunctionChain<
834 T extends Function4<T1, infer T2, infer T3, T4, infer R> ? Function2<T2, T3, R> :
835 any
836 >;
837 /**
838 * @see _.partial
839 */
840 partial<T2, T4>(plc1: __, arg2: T2, plc3: __, arg4: T4): FunctionChain<
841 T extends Function4<infer T1, T2, infer T3, T4, infer R> ? Function2<T1, T3, R> :
842 any
843 >;
844 /**
845 * @see _.partial
846 */
847 partial<T1, T2, T4>(arg1: T1, arg2: T2, plc3: __, arg4: T4): FunctionChain<
848 T extends Function4<T1, T2, infer T3, T4, infer R> ? Function1<T3, R> :
849 any
850 >;
851 /**
852 * @see _.partial
853 */
854 partial<T3, T4>(plc1: __, plc2: __, arg3: T3, arg4: T4): FunctionChain<
855 T extends Function4<infer T1, infer T2, T3, T4, infer R> ? Function2<T1, T2, R> :
856 any
857 >;
858 /**
859 * @see _.partial
860 */
861 partial<T1, T3, T4>(arg1: T1, plc2: __, arg3: T3, arg4: T4): FunctionChain<
862 T extends Function4<T1, infer T2, T3, T4, infer R> ? Function1<T2, R> :
863 any
864 >;
865 /**
866 * @see _.partial
867 */
868 partial<T2, T3, T4>(plc1: __, arg2: T2, arg3: T3, arg4: T4): FunctionChain<
869 T extends Function4<infer T1, T2, T3, T4, infer R> ? Function1<T1, R> :
870 any
871 >;
872 /**
873 * @see _.partial
874 */
875 partial<T1, T2, T3, T4>(arg1: T1, arg2: T2, arg3: T3, arg4: T4): FunctionChain<
876 T extends (t1: T1, t2: T2, t3: T3, t4: T4, ...ts: infer TS) => infer R ? (...ts: TS) => R :
877 any
878 >;
879 /**
880 * @see _.partial
881 */
882 partial<T1, T2, T3>(arg1: T1, arg2: T2, arg3: T3): FunctionChain<
883 T extends (t1: T1, t2: T2, t3: T3, ...ts: infer TS) => infer R ? (...ts: TS) => R :
884 any
885 >;
886 /**
887 * @see _.partial
888 */
889 partial<T1, T2>(arg1: T1, arg2: T2): FunctionChain<
890 T extends (t1: T1, t2: T2, ...ts: infer TS) => infer R ? (...ts: TS) => R :
891 any
892 >;
893 /**
894 * @see _.partial
895 */
896 partial<T1>(arg1: T1): FunctionChain<
897 T extends (t1: T1, ...ts: infer TS) => infer R ? (...ts: TS) => R :
898 any
899 >;
900 /**
901 * @see _.partial
902 */
903 partial(): FunctionChain<T extends (...ts: any[]) => any ? T : any>;
904 }
905 interface LoDashStatic {
906 /**
907 * This method is like _.partial except that partial arguments are appended to those provided
908 * to the new function.
909 * @param func The function to partially apply arguments to.
910 * @param args Arguments to be partially applied.
911 * @return The new partially applied function.
912 */
913 partialRight: PartialRight;
914 }
915 interface PartialRight {
916 <R>(func: Function0<R>): Function0<R>;
917 <T1, R>(func: Function1<T1, R>): Function1<T1, R>;
918 <T1, R>(func: Function1<T1, R>, arg1: T1): Function0<R>;
919 <T1, T2, R>(func: Function2<T1, T2, R>): Function2<T1, T2, R>;
920 <T1, T2, R>(func: Function2<T1, T2, R>, arg1: T1, plc2: __): Function1<T2, R>;
921 <T1, T2, R>(func: Function2<T1, T2, R>, arg2: T2): Function1<T1, R>;
922 <T1, T2, R>(func: Function2<T1, T2, R>, arg1: T1, arg2: T2): Function0<R>;
923 <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>): Function3<T1, T2, T3, R>;
924 <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, plc2: __, plc3: __): Function2<T2, T3, R>;
925 <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg2: T2, plc3: __): Function2<T1, T3, R>;
926 <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, arg2: T2, plc3: __): Function1<T3, R>;
927 <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg3: T3): Function2<T1, T2, R>;
928 <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, plc2: __, arg3: T3): Function1<T2, R>;
929 <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg2: T2, arg3: T3): Function1<T1, R>;
930 <T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3): Function0<R>;
931 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>): Function4<T1, T2, T3, T4, R>;
932 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, plc3: __, plc4: __): Function3<T2, T3, T4, R>;
933 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg2: T2, plc3: __, plc4: __): Function3<T1, T3, T4, R>;
934 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, plc3: __, plc4: __): Function2<T3, T4, R>;
935 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg3: T3, plc4: __): Function3<T1, T2, T4, R>;
936 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, arg3: T3, plc4: __): Function2<T2, T4, R>;
937 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg2: T2, arg3: T3, plc4: __): Function2<T1, T4, R>;
938 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, plc4: __): Function1<T4, R>;
939 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg4: T4): Function3<T1, T2, T3, R>;
940 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, plc3: __, arg4: T4): Function2<T2, T3, R>;
941 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg2: T2, plc3: __, arg4: T4): Function2<T1, T3, R>;
942 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, plc3: __, arg4: T4): Function1<T3, R>;
943 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg3: T3, arg4: T4): Function2<T1, T2, R>;
944 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: __, arg3: T3, arg4: T4): Function1<T2, R>;
945 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg2: T2, arg3: T3, arg4: T4): Function1<T1, R>;
946 <T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): Function0<R>;
947 (func: (...args: any[]) => any, ...args: any[]): (...args: any[]) => any;
948 placeholder: __;
949 }
950 interface Function<T extends (...args: any) => any> {
951 /**
952 * @see _.partialRight
953 */
954 partialRight<T1>(arg1: T1, plc2: __): Function<
955 T extends Function2<T1, infer T2, infer R> ? Function1<T2, R> :
956 any
957 >;
958 /**
959 * @see _.partialRight
960 */
961 partialRight<T2>(arg2: T2): Function<
962 T extends Function2<infer T1, T2, infer R> ? Function1<T1, R> : any
963 >;
964 /**
965 * @see _.partialRight
966 */
967 partialRight<T1>(arg1: T1, plc2: __, plc3: __): Function<
968 T extends Function3<T1, infer T2, infer T3, infer R> ? Function2<T2, T3, R> :
969 any
970 >;
971 /**
972 * @see _.partialRight
973 */
974 partialRight<T2>(arg2: T2, plc3: __): Function<
975 T extends Function3<infer T1, T2, infer T3, infer R> ? Function2<T1, T3, R> :
976 any
977 >;
978 /**
979 * @see _.partialRight
980 */
981 partialRight<T1, T2>(arg1: T1, arg2: T2, plc3: __): Function<
982 T extends Function3<T1, T2, infer T3, infer R> ? Function1<T3, R> :
983 any
984 >;
985 /**
986 * @see _.partialRight
987 */
988 partialRight<T3>(arg3: T3): Function<
989 T extends Function3<infer T1, infer T2, T3, infer R> ? Function2<T1, T2, R> :
990 any
991 >;
992 /**
993 * @see _.partialRight
994 */
995 partialRight<T1, T3>(arg1: T1, plc2: __, arg3: T3): Function<
996 T extends Function3<T1, infer T2, T3, infer R> ? Function1<T2, R> :
997 any
998 >;
999 /**
1000 * @see _.partialRight
1001 */
1002 partialRight<T2, T3>(arg2: T2, arg3: T3): Function<
1003 T extends Function3<infer T1, T2, T3, infer R> ? Function1<T1, R> :
1004 any
1005 >;
1006 /**
1007 * @see _.partialRight
1008 */
1009 partialRight<T1>(arg1: T1, plc2: __, plc3: __, plc4: __): Function<
1010 T extends Function4<T1, infer T2, infer T3, infer T4, infer R> ? Function3<T2, T3, T4, R> :
1011 any
1012 >;
1013 /**
1014 * @see _.partialRight
1015 */
1016 partialRight<T2>(arg2: T2, plc3: __, plc4: __): Function<
1017 T extends Function4<infer T1, T2, infer T3, infer T4, infer R> ? Function3<T1, T3, T4, R> :
1018 any
1019 >;
1020 /**
1021 * @see _.partialRight
1022 */
1023 partialRight<T1, T2>(arg1: T1, arg2: T2, plc3: __, plc4: __): Function<
1024 T extends Function4<T1, T2, infer T3, infer T4, infer R> ? Function2<T3, T4, R> :
1025 any
1026 >;
1027 /**
1028 * @see _.partialRight
1029 */
1030 partialRight<T3>(arg3: T3, plc4: __): Function<
1031 T extends Function4<infer T1, infer T2, T3, infer T4, infer R> ? Function3<T1, T2, T4, R> :
1032 any
1033 >;
1034 /**
1035 * @see _.partialRight
1036 */
1037 partialRight<T1, T3>(arg1: T1, plc2: __, arg3: T3, plc4: __): Function<
1038 T extends Function4<T1, infer T2, infer T3, infer T4, infer R> ? Function2<T2, T4, R> :
1039 any
1040 >;
1041 /**
1042 * @see _.partialRight
1043 */
1044 partialRight<T2, T3>(arg2: T2, arg3: T3, plc4: __): Function<
1045 T extends Function4<infer T1, T2, T3, infer T4, infer R> ? Function2<T1, T4, R> :
1046 any
1047 >;
1048 /**
1049 * @see _.partialRight
1050 */
1051 partialRight<T1, T2, T3>(arg1: T1, arg2: T2, arg3: T3, plc4: __): Function<
1052 T extends Function4<T1, T2, T3, infer T4, infer R> ? Function1<T4, R> :
1053 any
1054 >;
1055 /**
1056 * @see _.partialRight
1057 */
1058 partialRight<T4>(arg4: T4): Function<
1059 T extends Function4<infer T1, infer T2, infer T3, T4, infer R> ? Function3<T1, T2, T3, R> :
1060 any
1061 >;
1062 /**
1063 * @see _.partialRight
1064 */
1065 partialRight<T1, T4>(arg1: T1, plc2: __, plc3: __, arg4: T4): Function<
1066 T extends Function4<T1, infer T2, infer T3, T4, infer R> ? Function2<T2, T3, R> :
1067 any
1068 >;
1069 /**
1070 * @see _.partialRight
1071 */
1072 partialRight<T2, T4>(arg2: T2, plc3: __, arg4: T4): Function<
1073 T extends Function4<infer T1, T2, infer T3, T4, infer R> ? Function2<T1, T3, R> :
1074 any
1075 >;
1076 /**
1077 * @see _.partialRight
1078 */
1079 partialRight<T1, T2, T4>(arg1: T1, arg2: T2, plc3: __, arg4: T4): Function<
1080 T extends Function4<T1, T2, infer T3, T4, infer R> ? Function1<T3, R> :
1081 any
1082 >;
1083 /**
1084 * @see _.partialRight
1085 */
1086 partialRight<T3, T4>(arg3: T3, arg4: T4): Function<
1087 T extends Function4<infer T1, infer T2, T3, T4, infer R> ? Function2<T1, T2, R> :
1088 any
1089 >;
1090 /**
1091 * @see _.partialRight
1092 */
1093 partialRight<T1, T3, T4>(arg1: T1, plc2: __, arg3: T3, arg4: T4): Function<
1094 T extends Function4<T1, infer T2, T3, T4, infer R> ? Function1<T2, R> :
1095 any
1096 >;
1097 /**
1098 * @see _.partialRight
1099 */
1100 partialRight<T2, T3, T4>(arg2: T2, arg3: T3, arg4: T4): Function<
1101 T extends Function4<infer T1, T2, T3, T4, infer R> ? Function1<T1, R> :
1102 any
1103 >;
1104 /**
1105 * @see _.partialRight
1106 */
1107 partialRight<TS extends any[]>(...ts: TS): Function<T extends (...args: TS) => infer R ? () => R : any>;
1108 /**
1109 * @see _.partialRight
1110 */
1111 partialRight(): Function<T extends (...ts: any[]) => any ? T : any>;
1112 }
1113 interface FunctionChain<T extends (...args: any) => any> {
1114 /**
1115 * @see _.partialRight
1116 */
1117 partialRight<T1>(arg1: T1, plc2: __): FunctionChain<
1118 T extends Function2<T1, infer T2, infer R> ? Function1<T2, R> :
1119 any
1120 >;
1121 /**
1122 * @see _.partialRight
1123 */
1124 partialRight<T2>(arg2: T2): FunctionChain<
1125 T extends Function2<infer T1, T2, infer R> ? Function1<T1, R> : any
1126 >;
1127 /**
1128 * @see _.partialRight
1129 */
1130 partialRight<T1>(arg1: T1, plc2: __, plc3: __): FunctionChain<
1131 T extends Function3<T1, infer T2, infer T3, infer R> ? Function2<T2, T3, R> :
1132 any
1133 >;
1134 /**
1135 * @see _.partialRight
1136 */
1137 partialRight<T2>(arg2: T2, plc3: __): FunctionChain<
1138 T extends Function3<infer T1, T2, infer T3, infer R> ? Function2<T1, T3, R> :
1139 any
1140 >;
1141 /**
1142 * @see _.partialRight
1143 */
1144 partialRight<T1, T2>(arg1: T1, arg2: T2, plc3: __): FunctionChain<
1145 T extends Function3<T1, T2, infer T3, infer R> ? Function1<T3, R> :
1146 any
1147 >;
1148 /**
1149 * @see _.partialRight
1150 */
1151 partialRight<T3>(arg3: T3): FunctionChain<
1152 T extends Function3<infer T1, infer T2, T3, infer R> ? Function2<T1, T2, R> :
1153 any
1154 >;
1155 /**
1156 * @see _.partialRight
1157 */
1158 partialRight<T1, T3>(arg1: T1, plc2: __, arg3: T3): FunctionChain<
1159 T extends Function3<T1, infer T2, T3, infer R> ? Function1<T2, R> :
1160 any
1161 >;
1162 /**
1163 * @see _.partialRight
1164 */
1165 partialRight<T2, T3>(arg2: T2, arg3: T3): FunctionChain<
1166 T extends Function3<infer T1, T2, T3, infer R> ? Function1<T1, R> :
1167 any
1168 >;
1169 /**
1170 * @see _.partialRight
1171 */
1172 partialRight<T1>(arg1: T1, plc2: __, plc3: __, plc4: __): FunctionChain<
1173 T extends Function4<T1, infer T2, infer T3, infer T4, infer R> ? Function3<T2, T3, T4, R> :
1174 any
1175 >;
1176 /**
1177 * @see _.partialRight
1178 */
1179 partialRight<T2>(arg2: T2, plc3: __, plc4: __): FunctionChain<
1180 T extends Function4<infer T1, T2, infer T3, infer T4, infer R> ? Function3<T1, T3, T4, R> :
1181 any
1182 >;
1183 /**
1184 * @see _.partialRight
1185 */
1186 partialRight<T1, T2>(arg1: T1, arg2: T2, plc3: __, plc4: __): FunctionChain<
1187 T extends Function4<T1, T2, infer T3, infer T4, infer R> ? Function2<T3, T4, R> :
1188 any
1189 >;
1190 /**
1191 * @see _.partialRight
1192 */
1193 partialRight<T3>(arg3: T3, plc4: __): FunctionChain<
1194 T extends Function4<infer T1, infer T2, T3, infer T4, infer R> ? Function3<T1, T2, T4, R> :
1195 any
1196 >;
1197 /**
1198 * @see _.partialRight
1199 */
1200 partialRight<T1, T3>(arg1: T1, plc2: __, arg3: T3, plc4: __): FunctionChain<
1201 T extends Function4<T1, infer T2, infer T3, infer T4, infer R> ? Function2<T2, T4, R> :
1202 any
1203 >;
1204 /**
1205 * @see _.partialRight
1206 */
1207 partialRight<T2, T3>(arg2: T2, arg3: T3, plc4: __): FunctionChain<
1208 T extends Function4<infer T1, T2, T3, infer T4, infer R> ? Function2<T1, T4, R> :
1209 any
1210 >;
1211 /**
1212 * @see _.partialRight
1213 */
1214 partialRight<T1, T2, T3>(arg1: T1, arg2: T2, arg3: T3, plc4: __): FunctionChain<
1215 T extends Function4<T1, T2, T3, infer T4, infer R> ? Function1<T4, R> :
1216 any
1217 >;
1218 /**
1219 * @see _.partialRight
1220 */
1221 partialRight<T4>(arg4: T4): FunctionChain<
1222 T extends Function4<infer T1, infer T2, infer T3, T4, infer R> ? Function3<T1, T2, T3, R> :
1223 any
1224 >;
1225 /**
1226 * @see _.partialRight
1227 */
1228 partialRight<T1, T4>(arg1: T1, plc2: __, plc3: __, arg4: T4): FunctionChain<
1229 T extends Function4<T1, infer T2, infer T3, T4, infer R> ? Function2<T2, T3, R> :
1230 any
1231 >;
1232 /**
1233 * @see _.partialRight
1234 */
1235 partialRight<T2, T4>(arg2: T2, plc3: __, arg4: T4): FunctionChain<
1236 T extends Function4<infer T1, T2, infer T3, T4, infer R> ? Function2<T1, T3, R> :
1237 any
1238 >;
1239 /**
1240 * @see _.partialRight
1241 */
1242 partialRight<T1, T2, T4>(arg1: T1, arg2: T2, plc3: __, arg4: T4): FunctionChain<
1243 T extends Function4<T1, T2, infer T3, T4, infer R> ? Function1<T3, R> :
1244 any
1245 >;
1246 /**
1247 * @see _.partialRight
1248 */
1249 partialRight<T3, T4>(arg3: T3, arg4: T4): FunctionChain<
1250 T extends Function4<infer T1, infer T2, T3, T4, infer R> ? Function2<T1, T2, R> :
1251 any
1252 >;
1253 /**
1254 * @see _.partialRight
1255 */
1256 partialRight<T1, T3, T4>(arg1: T1, plc2: __, arg3: T3, arg4: T4): FunctionChain<
1257 T extends Function4<T1, infer T2, T3, T4, infer R> ? Function1<T2, R> :
1258 any
1259 >;
1260 /**
1261 * @see _.partialRight
1262 */
1263 partialRight<T2, T3, T4>(arg2: T2, arg3: T3, arg4: T4): FunctionChain<
1264 T extends Function4<infer T1, T2, T3, T4, infer R> ? Function1<T1, R> :
1265 any
1266 >;
1267 /**
1268 * @see _.partialRight
1269 */
1270 partialRight<TS extends any[]>(...ts: TS): FunctionChain<T extends (...args: TS) => infer R ? () => R : any>;
1271 /**
1272 * @see _.partialRight
1273 */
1274 partialRight(): FunctionChain<T extends (...ts: any[]) => any ? T : any>;
1275 }
1276 interface LoDashStatic {
1277 /**
1278 * Creates a function that invokes func with arguments arranged according to the specified indexes where the
1279 * argument value at the first index is provided as the first argument, the argument value at the second index
1280 * is provided as the second argument, and so on.
1281 * @param func The function to rearrange arguments for.
1282 * @param indexes The arranged argument indexes, specified as individual indexes or arrays of indexes.
1283 * @return Returns the new function.
1284 */
1285 rearg(func: (...args: any[]) => any, ...indexes: Array<Many<number>>): (...args: any[]) => any;
1286 }
1287 interface Function<T extends (...args: any) => any> {
1288 /**
1289 * @see _.rearg
1290 */
1291 rearg(...indexes: Array<Many<number>>): Function<(...args: any[]) => any>;
1292 }
1293 interface FunctionChain<T extends (...args: any) => any> {
1294 /**
1295 * @see _.rearg
1296 */
1297 rearg(...indexes: Array<Many<number>>): FunctionChain<(...args: any[]) => any>;
1298 }
1299 interface LoDashStatic {
1300 /**
1301 * Creates a function that invokes func with the this binding of the created function and arguments from start
1302 * and beyond provided as an array.
1303 *
1304 * Note: This method is based on the rest parameter.
1305 *
1306 * @param func The function to apply a rest parameter to.
1307 * @param start The start position of the rest parameter.
1308 * @return Returns the new function.
1309 */
1310 rest(func: (...args: any[]) => any, start?: number): (...args: any[]) => any;
1311 }
1312 interface Function<T extends (...args: any) => any> {
1313 /**
1314 * @see _.rest
1315 */
1316 rest(start?: number): Function<(...args: any[]) => any>;
1317 }
1318 interface FunctionChain<T extends (...args: any) => any> {
1319 /**
1320 * @see _.rest
1321 */
1322 rest(start?: number): FunctionChain<(...args: any[]) => any>;
1323 }
1324 interface LoDashStatic {
1325 /**
1326 * Creates a function that invokes func with the this binding of the created function and an array of arguments
1327 * much like Function#apply.
1328 *
1329 * Note: This method is based on the spread operator.
1330 *
1331 * @param func The function to spread arguments over.
1332 * @return Returns the new function.
1333 */
1334 spread<TResult>(func: (...args: any[]) => TResult, start?: number): (...args: any[]) => TResult;
1335 }
1336 interface Function<T extends (...args: any) => any> {
1337 /**
1338 * @see _.spread
1339 */
1340 spread(start?: number): Function<(...args: any[]) => ReturnType<T>>;
1341 }
1342 interface FunctionChain<T extends (...args: any) => any> {
1343 /**
1344 * @see _.spread
1345 */
1346 spread(start?: number): FunctionChain<(...args: any[]) => ReturnType<T>>;
1347 }
1348 interface ThrottleSettings {
1349 /**
1350 * @see _.leading
1351 */
1352 leading?: boolean | undefined;
1353 /**
1354 * @see _.trailing
1355 */
1356 trailing?: boolean | undefined;
1357 }
1358 interface LoDashStatic {
1359 /**
1360 * Creates a throttled function that only invokes func at most once per every wait milliseconds. The throttled
1361 * function comes with a cancel method to cancel delayed invocations and a flush method to immediately invoke
1362 * them. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge
1363 * of the wait timeout. Subsequent calls to the throttled function return the result of the last func call.
1364 *
1365 * Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if
1366 * the the throttled function is invoked more than once during the wait timeout.
1367 *
1368 * @param func The function to throttle.
1369 * @param wait The number of milliseconds to throttle invocations to.
1370 * @param options The options object.
1371 * @param options.leading Specify invoking on the leading edge of the timeout.
1372 * @param options.trailing Specify invoking on the trailing edge of the timeout.
1373 * @return Returns the new throttled function.
1374 */
1375 throttle<T extends (...args: any) => any>(func: T, wait?: number, options?: ThrottleSettings): DebouncedFunc<T>;
1376 }
1377 interface Function<T extends (...args: any) => any> {
1378 /**
1379 * @see _.throttle
1380 */
1381 throttle(
1382 wait?: number,
1383 options?: ThrottleSettings
1384 ): T extends (...args: any[]) => any ? Function<DebouncedFunc<T>> : never;
1385 }
1386 interface FunctionChain<T extends (...args: any) => any> {
1387 /**
1388 * @see _.throttle
1389 */
1390 throttle(
1391 wait?: number,
1392 options?: ThrottleSettings
1393 ): T extends (...args: any[]) => any ? FunctionChain<DebouncedFunc<T>> : never;
1394 }
1395 interface LoDashStatic {
1396 /**
1397 * Creates a function that accepts up to one argument, ignoring any
1398 * additional arguments.
1399 *
1400 * @category Function
1401 * @param func The function to cap arguments for.
1402 * @returns Returns the new function.
1403 * @example
1404 *
1405 * _.map(['6', '8', '10'], _.unary(parseInt));
1406 * // => [6, 8, 10]
1407 */
1408 unary<T, TResult>(func: (arg1: T, ...args: any[]) => TResult): (arg1: T) => TResult;
1409 }
1410 interface Function<T extends (...args: any) => any> {
1411 /**
1412 * @see _.unary
1413 */
1414 unary(): Function<(arg1: Parameters<T>['0']) => ReturnType<T>>;
1415 }
1416 interface FunctionChain<T extends (...args: any) => any> {
1417 /**
1418 * @see _.unary
1419 */
1420 unary(): FunctionChain<(arg1: Parameters<T>['0']) => ReturnType<T>>;
1421 }
1422 interface LoDashStatic {
1423 /**
1424 * Creates a function that provides value to the wrapper function as its first argument. Any additional
1425 * arguments provided to the function are appended to those provided to the wrapper function. The wrapper is
1426 * invoked with the this binding of the created function.
1427 *
1428 * @param value The value to wrap.
1429 * @param wrapper The wrapper function.
1430 * @return Returns the new function.
1431 */
1432 wrap<T, TArgs, TResult>(value: T, wrapper: (value: T, ...args: TArgs[]) => TResult): (...args: TArgs[]) => TResult;
1433 }
1434 interface LoDashImplicitWrapper<TValue> {
1435 /**
1436 * @see _.wrap
1437 */
1438 wrap<TArgs, TResult>(wrapper: (value: TValue, ...args: TArgs[]) => TResult): Function<(...args: TArgs[]) => TResult>;
1439 }
1440 interface LoDashExplicitWrapper<TValue> {
1441 /**
1442 * @see _.wrap
1443 */
1444 wrap<TArgs, TResult>(wrapper: (value: TValue, ...args: TArgs[]) => TResult): FunctionChain<(...args: TArgs[]) => TResult>;
1445 }
1446}