1---
2category: Animation
3---
4 
5# useTimeoutFn
6 
7Wrapper for `setTimeout` with controls.
8 
9## Usage
10 
11```ts
12import { useTimeoutFn } from '@vueuse/core'
13 
14const { isPending, start, stop } = useTimeoutFn(() => {
15  /* ... */
16}, 3000)
17```
18 
19## Type Declarations
20 
21```ts
22export interface UseTimeoutFnOptions {
23  /**
24   * Start the timer immediately
25   *
26   * @default true
27   */
28  immediate?: boolean
29  /**
30   * Execute the callback immediately after calling `start`
31   *
32   * @default false
33   */
34  immediateCallback?: boolean
35}
36export type UseTimeoutFnReturn<CallbackFn extends AnyFn> = Stoppable<
37  Parameters<CallbackFn> | []
38>
39/**
40 * Wrapper for `setTimeout` with controls.
41 *
42 * @param cb
43 * @param interval
44 * @param options
45 */
46export declare function useTimeoutFn<CallbackFn extends AnyFn>(
47  cb: CallbackFn,
48  interval: MaybeRefOrGetter<number>,
49  options?: UseTimeoutFnOptions,
50): UseTimeoutFnReturn<CallbackFn>
51```
52