Skip to content

useInterval ​

Category
Export Size
620 B
Last Changed
last year

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 ​

Source • Demo • Docs

Contributors ​

Anthony Fu
Jelf
mohammadhosry
Waleed Khaled
vaakian X
Nurettin Kaya

Changelog ​

v10.0.0-beta.4 on 4/13/2023
4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter
v9.13.0 on 2/18/2023
db66c - fix: fix types
81db6 - feat: add reset function (#2686)
v9.3.0 on 9/26/2022
33dbc - feat: optional callback for useInterval, useTimeout & useTimestamp (#2240)
v9.0.0-beta.1 on 7/20/2022
43732 - fix!: rename type IntervalOptions to UseIntervalOptions (#1945)

Released under the MIT License.