1---
2category: Animation
3---
4 
5# useIntervalFn
6 
7Wrapper for `setInterval` with controls
8 
9## Usage
10 
11```ts
12import { useIntervalFn } from '@vueuse/core'
13 
14const { pause, resume, isActive } = useIntervalFn(() => {
15  /* your function */
16}, 1000)
17```
18 
19## Type Declarations
20 
21```ts
22export interface UseIntervalFnOptions {
23  /**
24   * Start the timer immediately
25   *
26   * @default true
27   */
28  immediate?: boolean
29  /**
30   * Execute the callback immediately after calling `resume`
31   *
32   * @default false
33   */
34  immediateCallback?: boolean
35}
36export type UseIntervalFnReturn = Pausable
37/**
38 * Wrapper for `setInterval` with controls
39 *
40 * @see https://vueuse.org/useIntervalFn
41 * @param cb
42 * @param interval
43 * @param options
44 */
45export declare function useIntervalFn(
46  cb: Fn,
47  interval?: MaybeRefOrGetter<number>,
48  options?: UseIntervalFnOptions,
49): UseIntervalFnReturn
50```
51