Skip to content
On this page

useInterval

Category
Export Size
638 B
Last Changed
last month

Reactive counter increases on every interval

Demo

Interval fired: 0

Usage




 





import { useInterval } from '@vueuse/core'

// count will increase every 200ms
const counter = useInterval(200)
import { useInterval } from '@vueuse/core'

// count will increase every 200ms
const counter = useInterval(200)
const { counter, pause, resume } = useInterval(200, { controls: true })
const { counter, pause, resume } = useInterval(200, { controls: true })

Type Declarations

export interface UseIntervalOptions<Controls extends boolean> {
  /**
   * Expose more controls
   *
   * @default false
   */
  controls?: Controls
  /**
   * Execute the update immediately on calling
   *
   * @default true
   */
  immediate?: boolean
}
/**
 * Reactive counter increases on every interval
 *
 * @see https://vueuse.org/useInterval
 * @param interval
 * @param options
 */
export declare function useInterval(
  interval?: MaybeComputedRef<number>,
  options?: UseIntervalOptions<false>
): Ref<number>
export declare function useInterval(
  interval: MaybeComputedRef<number>,
  options: UseIntervalOptions<true>
): {
  counter: Ref<number>
} & Pausable
export interface UseIntervalOptions<Controls extends boolean> {
  /**
   * Expose more controls
   *
   * @default false
   */
  controls?: Controls
  /**
   * Execute the update immediately on calling
   *
   * @default true
   */
  immediate?: boolean
}
/**
 * Reactive counter increases on every interval
 *
 * @see https://vueuse.org/useInterval
 * @param interval
 * @param options
 */
export declare function useInterval(
  interval?: MaybeComputedRef<number>,
  options?: UseIntervalOptions<false>
): Ref<number>
export declare function useInterval(
  interval: MaybeComputedRef<number>,
  options: UseIntervalOptions<true>
): {
  counter: Ref<number>
} & Pausable

Source

SourceDemoDocs

Contributors

Anthony Fu
Jelf
vaakian X
Nurettin Kaya

Changelog

v9.0.0-beta.1 on 7/20/2022
43732 - fix!: rename type IntervalOptions to UseIntervalOptions (#1945)
v8.9.1 on 7/8/2022
a9ccc - feat(all): use MaybeComputedRef (#1768)
v7.6.0 on 2/8/2022
a2b2b - feat: support ref as interval (#1215)

Released under the MIT License.