useTimeoutFn

v0.0.14testeddemo

Call a function after a given delay, with manual start/stop control and a reactive isPending flag. SSR-safe and cleans up on scope dispose.

Examples

const { isPending, start, stop } = useTimeoutFn(() => {
  console.log('fired');
}, 1000);

// Fire once now and again after the delay
useTimeoutFn(refresh, 5000, { immediateCallback: true });

Loading demo…

export function useTimeoutFn<T extends AnyFunction>(
  cb: T,
  interval: MaybeRefOrGetter<number>,
  options: UseTimeoutFnOptions ={ ... }

Textends AnyFunction

Parameter	Type	Default	Description
`cb`	`T`	—	The function to call after the timeout
`interval`	`MaybeRefOrGetter<number>`	—	Delay in milliseconds (resolved each time `start` runs, can be reactive)
`options`?	`UseTimeoutFnOptions`	`{}`	Options

UseTimeoutFnReturn<Parameters<T>>Timeout controls

Property	Type	Default	Description
`isPending`	`Readonly<Ref<boolean>>`	—	Whether the timeout is currently pending
`start`	`(...args: Args) => void`	—	Start (or restart) the timeout
`stop`	`() => void`	—	Cancel the pending timeout