Skip to content
On this page

useTimeoutPoll

Use timeout to poll something. It's will trigger callback after last task is done.

Demo

Category
Last Changed
last month
Count: 0
isActive: false

Usage

import { useTimeoutPoll } from '@vueuse/core'

const count = ref(0)

const fetchData = async () => {
  await promiseTimeout(1000)
  count.value++
}

// Only trigger after last fetch is done
const { isActive, pause, resume } = useTimeoutPoll(fetchData, 1000)
import { useTimeoutPoll } from '@vueuse/core'

const count = ref(0)

const fetchData = async () => {
  await promiseTimeout(1000)
  count.value++
}

// Only trigger after last fetch is done
const { isActive, pause, resume } = useTimeoutPoll(fetchData, 1000)

Type Declarations

export declare function useTimeoutPoll(
  fn: () => Awaitable<void>,
  interval: MaybeComputedRef<number>,
  timeoutPollOptions?: UseTimeoutFnOptions
): Pausable
export declare function useTimeoutPoll(
  fn: () => Awaitable<void>,
  interval: MaybeComputedRef<number>,
  timeoutPollOptions?: UseTimeoutFnOptions
): Pausable

Source

SourceDemoDocs

Contributors

Anthony Fu
Jelf
Wenlu Wang

Changelog

v9.0.0-beta.1 on 7/20/2022
4ca70 - fix(useTimeoutFn,useTimeout)!: rename type TimeoutOptions to UseTimeoutOptions and TimeoutFnOptions to UseTimeoutFnOptions (#1944)

Released under the MIT License.