跳到主要內容

useTimeoutPoll

分類
匯出大小
411 B
最後變更
5 天前

使用 timeout 來輪詢某些內容。它會在最後一個任務完成後觸發回調。

範例

計數: 0
isActive: false

用法

ts
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)

類型宣告

typescript
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

原始碼

原始碼範例文件

貢獻者

Anthony Fu
Anthony Fu
IlyaL
Hongkun
OrbisK
Sebastien
David Vallejo
jiadesen
sun0day
Jelf
Wenlu Wang

更新日誌

v12.8.0 於 2025/3/5
7432f - 新功能(types): 棄用 MaybeRefMaybeRefOrGetter,採用 Vue 原生 (#4636)
v12.6.0 於 2025/2/14
64c53 - 新功能(useTimtoutFn,useTimeoutPoll): 對齊行為 (#4543)
v12.3.0 於 2025/1/2
a5fb0 - 修復: 預設僅在客戶端啟動
0450d - 修復: immediate 預設值應為 true (#4232)
v12.0.0-beta.1 於 2024/11/21
0a9ed - 新功能!: 移除 Vue 2 支援,優化 bundle 並清理 (#4349)
v10.2.1 於 2023/6/28
7a897 - 修復: 意外的立即執行 (#3159)
v10.0.0-beta.4 於 2023/4/13
4d757 - 新功能(types)!: 重新命名 MaybeComputedRefMaybeRefOrGetter

以 MIT 授權條款發布。