useTimeoutPoll

类别

Utilities

导出体积

414 B

上次更改

7 months ago

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

示例

源码 playground (beta)

Count: 0

isActive: false

用法

import { useTimeoutPoll
 } from '@vueuse/core'

const count
 = ref
(0)

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

// 仅在最后一个获取完成后触发
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