VueUseuseTimeoutPoll
Use timeout to poll something. It's will trigger callback after last task is done.
Demo
Count: 0
isActive: false
Usage
ts
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
typescript
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
Contributors
Anthony Fu
sun0day
Jelf
Wenlu WangChangelog
v9.0.0-beta.1 on 7/20/20224ca70 - fix(useTimeoutFn,useTimeout)!: rename type TimeoutOptions to UseTimeoutOptions and TimeoutFnOptions to UseTimeoutFnOptions (#1944)v8.9.1 on 7/8/2022v8.0.0-beta.1 on 3/5/2022