useTimeoutPoll

使用超时来轮询某些内容。它将在最后一个任务完成后触发回调。

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

示例

源代码

Count: 0

isActive: false

用法

¥Usage

import { useTimeoutPoll } from '@vueuse/core'

const count = ref(0)

async function fetchData() {
  await new Promise(resolve => setTimeout(resolve, 1000))
  count.value++
}

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

类型声明

export interface UseTimeoutPollOptions {
  /**
   * Start the timer immediately
   *
   * @default true
   */
  immediate?: boolean
  /**
   * Execute the callback immediately after calling `resume`
   *
   * @default false
   */
  immediateCallback?: boolean
}
export declare function useTimeoutPoll(
  fn: () => Awaitable<void>,
  interval: MaybeRefOrGetter<number>,
  options?: UseTimeoutFnOptions,
): Pausable

源代码

源代码 • 示例 • 文档

变更日志

v12.8.0 on

7432f - feat(types): deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native (#4636)

v12.6.0 on

64c53 - feat(useTimtoutFn,useTimeoutPoll): align behavior (#4543)