Fix incorrect TypeScript type (#1)

sindresorhus · May 17, 2024 · a87ea53 · a87ea53
1 parent dcf1b5c
commit a87ea53
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -31,7 +31,7 @@ try {
 }
 ```
 */
-export default function functionTimeout<T extends Function>(function_: T, options: Options): T; // eslint-disable-line @typescript-eslint/ban-types
+export default function functionTimeout<T extends Function>(function_: T, options?: Options): T; // eslint-disable-line @typescript-eslint/ban-types
 
 /**
 Returns a boolean for whether the given error is a timeout error.

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -1,6 +1,8 @@
 import {expectType} from 'tsd';
 import functionTimeout from './index.js';
 
-const function_ = functionTimeout((number: number) => number * 2, {timeout: 100});
+const function1_ = functionTimeout((number: number) => number * 2, {timeout: 100});
+expectType<number>(function1_(2));
 
-expectType<number>(function_(2));
+const function2_ = functionTimeout((number: number) => number * 2);
+expectType<number>(function2_(2));
-Original file line number
+Diff line change
@@ Expand Up / @@ -31,7 +31,7 @@ try { @@
     }
     ```
     */
-    export default function functionTimeout<T extends Function>(function_: T, options: Options): T; // eslint-disable-line @typescript-eslint/ban-types
+    export default function functionTimeout<T extends Function>(function_: T, options?: Options): T; // eslint-disable-line @typescript-eslint/ban-types
     /**
     Returns a boolean for whether the given error is a timeout error.
@@ Expand Down @@