fix(useTimeoutFn): respect callback parameters in start function (#2693)

vueuse · Jan 29, 2023 · e054a24 · e054a24
1 parent 77287e6
commit e054a24
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/packages/shared/useTimeoutFn/index.ts b/packages/shared/useTimeoutFn/index.ts
@@ -20,11 +20,11 @@ export interface UseTimeoutFnOptions {
  * @param interval
  * @param options
  */
-export function useTimeoutFn(
-  cb: (...args: unknown[]) => any,
+export function useTimeoutFn<CallbackFn extends(...args: any[]) => any>(
+  cb: CallbackFn,
   interval: MaybeComputedRef<number>,
   options: UseTimeoutFnOptions = {},
-): Stoppable {
+): Stoppable<Parameters<CallbackFn> | []> {
   const {
     immediate = true,
   } = options
@@ -45,7 +45,7 @@ export function useTimeoutFn(
     clear()
   }
 
-  function start(...args: unknown[]) {
+  function start(...args: Parameters<CallbackFn> | []) {
     clear()
     isPending.value = true
     timer = setTimeout(() => {

diff --git a/packages/shared/utils/types.ts b/packages/shared/utils/types.ts
@@ -97,7 +97,7 @@ export interface Pausable {
   resume: Fn
 }
 
-export interface Stoppable {
+export interface Stoppable<StartFnArgs extends any[] = any[]> {
   /**
    * A ref indicate whether a stoppable instance is executing
    */
@@ -111,7 +111,7 @@ export interface Stoppable {
   /**
    * Start the effects
    */
-  start: Fn
+  start: (...args: StartFnArgs) => void
 }
 
 /**