useInterval ​
Reactive counter increases on every interval
Demo ​
Interval fired: 0
Usage ​
js
import { useInterval } from '@vueuse/core'
// count will increase every 200ms
const counter = useInterval(200)
ts
const { counter, reset, pause, resume } = useInterval(200, { controls: true })
Type Declarations ​
typescript
export interface UseIntervalOptions<Controls extends boolean> {
/**
* Expose more controls
*
* @default false
*/
controls?: Controls
/**
* Execute the update immediately on calling
*
* @default true
*/
immediate?: boolean
/**
* Callback on every interval
*/
callback?: (count: number) => void
}
export interface UseIntervalControls {
counter: Ref<number>
reset: () => void
}
/**
* Reactive counter increases on every interval
*
* @see https://vueuse.org/useInterval
* @param interval
* @param options
*/
export declare function useInterval(
interval?: MaybeRefOrGetter<number>,
options?: UseIntervalOptions<false>,
): Ref<number>
export declare function useInterval(
interval: MaybeRefOrGetter<number>,
options: UseIntervalOptions<true>,
): UseIntervalControls & Pausable
Source ​
Contributors ​
Anthony Fu
Jelf
Anthony Fu
mohammadhosry
Waleed Khaled
vaakian X
Nurettin Kaya
Changelog ​
v12.0.0-beta.1
on 11/21/2024v10.0.0-beta.4
on 4/13/20234d757
- feat(types)!: rename MaybeComputedRef
to MaybeRefOrGetter
v9.13.0
on 2/18/2023db66c
- fix: fix typesv9.3.0
on 9/26/2022