Fix handling of generic functions in the types

Fixes #34
sindresorhus · Nov 17, 2023 · 329a240 · 329a240
1 parent 598642e
commit 329a240
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 21 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -4,7 +4,9 @@ export class AbortError extends Error {
  private constructor();
 }
 
-export type ThrottledFunction<Argument extends readonly unknown[], ReturnValue> = ((...arguments: Argument) => Awaited<ReturnValue>) & {
+type AnyFunction = (...arguments_: readonly any[]) => unknown;
+
+export type ThrottledFunction<F extends AnyFunction> = F & {
  /**
  Whether future function calls should be throttled or count towards throttling thresholds.
 
@@ -78,4 +80,4 @@ for (let index = 1; index <= 6; index++) {
 //=> 6: 2s
 ```
 */
-export default function pThrottle(options: Options): <Argument extends readonly unknown[], ReturnValue>(function_: (...arguments: Argument) => ReturnValue) => ThrottledFunction<Argument, ReturnValue>;
+export default function pThrottle(options: Options): <F extends AnyFunction>(function_: F) => ThrottledFunction<F>;
diff --git a/index.test-d.ts b/index.test-d.ts
@@ -11,34 +11,30 @@ const throttledLazyUnicorn = pThrottle({
  interval: 1000,
 })(async (_index: string) => '🦄');
 
-const strictThrottledUnicorn = pThrottle({
- limit: 1,
- interval: 1000,
- strict: true,
-})((_index: string) => '🦄');
-
-const strictThrottledLazyUnicorn = pThrottle({
- limit: 1,
- interval: 1000,
- strict: true,
-})(async (_index: string) => '🦄');
-
 const throttledTaggedUnicorn = pThrottle({
  limit: 1,
  interval: 1000,
 })((_index: number, tag: string) => `${tag}: 🦄`);
 
-expectType<ThrottledFunction<[string], string>>(throttledUnicorn);
-expectType<ThrottledFunction<[string], Promise<string>>>(throttledLazyUnicorn);
-expectType<ThrottledFunction<[string], string>>(strictThrottledUnicorn);
-expectType<ThrottledFunction<[string], Promise<string>>>(strictThrottledLazyUnicorn);
-expectType<ThrottledFunction<[number, string], Promise<string>>>(throttledTaggedUnicorn);
+expectType<string>(throttledUnicorn(''));
+expectType<string>(await throttledLazyUnicorn(''));
+expectType<string>(throttledTaggedUnicorn(1, 'foo'));
 
 throttledUnicorn.abort();
 throttledLazyUnicorn.abort();
-strictThrottledUnicorn.abort();
-strictThrottledLazyUnicorn.abort();
 throttledTaggedUnicorn.abort();
 
 expectType<boolean>(throttledUnicorn.isEnabled);
 expectType<number>(throttledUnicorn.queueSize);
+
+/* Generic */
+declare function genericFunction<T>(argument: T): Promise<T>;
+
+const throttledGenericFunction = pThrottle({
+ limit: 1,
+ interval: 1000,
+})(genericFunction);
+
+expectType<string>(await throttledGenericFunction('test'));
+expectType<number>(await throttledGenericFunction(123));
+/* /Generic */