跳到主要內容

useIntervalFn

分類
匯出大小
368 B
上次變更
5 天前

setInterval 的帶控制項的包裝器

範例

哈囉

間隔

用法

js
import { useIntervalFn } from '@vueuse/core'

const { pause, resume, isActive } = useIntervalFn(() => {
  /* your function */
}, 1000)

類型宣告

typescript
export interface UseIntervalFnOptions {
  /**
   * Start the timer immediately
   *
   * @default true
   */
  immediate?: boolean
  /**
   * Execute the callback immediately after calling `resume`
   *
   * @default false
   */
  immediateCallback?: boolean
}
/**
 * Wrapper for `setInterval` with controls
 *
 * @param cb
 * @param interval
 * @param options
 */
export declare function useIntervalFn(
  cb: Fn,
  interval?: MaybeRefOrGetter<number>,
  options?: UseIntervalFnOptions,
): Pausable

原始碼

原始碼範例文件

貢獻者

Anthony Fu
Anthony Fu
Jelf
IlyaL
OrbisK
Lapor Chen
Börge Kiss
Dan Rose
sun0day
Enzo Innocenzi
wwj
Matvey Melishev
meteorlxy
Aurélio A. Heckert
xuxuhahaha
Hogne Vevle
Daiki Ojima

更新日誌

v12.8.0 on 3/5/2025
7432f - feat(types): 棄用 MaybeRefMaybeRefOrGetter,改用 Vue 原生方法 (#4636)
v12.3.0 on 1/2/2025
59f75 - feat(toValue): 棄用 @vueuse/shared 中的 toValue,改用 Vue 原生方法
v12.0.0-beta.1 on 11/21/2024
0a9ed - feat!: 移除 Vue 2 支援,最佳化 bundle 並清理程式碼 (#4349)
v11.2.0 on 10/30/2024
59f8c - fix: 防止在 cb 中呼叫 pause 後仍然設定計時器 (#4258)
v10.0.0-beta.5 on 4/13/2023
cb644 - refactor!: 移除 isFunctionisString 工具函式
v10.0.0-beta.4 on 4/13/2023
4d757 - feat(types)!: 將 MaybeComputedRef 重新命名為 MaybeRefOrGetter
0a72b - feat(toValue): 將 resolveUnref 重新命名為 toValue
v9.12.0 on 1/29/2023
39183 - feat(useRafFn, useIntervalFn, useTimeoutFn): 將狀態設為唯讀 (#2685)

以 MIT 授權條款發布。