useIntervalFn
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
原始碼
貢獻者
更新日誌
v12.8.0
on 3/5/2025v12.3.0
on 1/2/202559f75
- feat(toValue): 棄用 @vueuse/shared
中的 toValue
,改用 Vue 原生方法v12.0.0-beta.1
on 11/21/2024v11.2.0
on 10/30/2024v10.0.0-beta.5
on 4/13/2023cb644
- refactor!: 移除 isFunction
和 isString
工具函式v10.0.0-beta.4
on 4/13/20234d757
- feat(types)!: 將 MaybeComputedRef
重新命名為 MaybeRefOrGetter
0a72b
- feat(toValue): 將 resolveUnref
重新命名為 toValue
v9.12.0
on 1/29/2023