useIntervalFn
一个 React Hook,用于创建一个每隔一定时间(以毫秒为单位)调用的函数。
演示
用法
请查看 API。
源码
API
const controls = useIntervalFn(callback, interval, options)
回调函数 Callback
一个将每隔一定时间(以毫秒为单位)被调用的 function
。
间隔 Interval
一个 number
,表示以毫秒为单位的时间间隔。
选项 Options
export interface UseIntervalFnOptions {
/**
* 组件挂载时是否立即开始计时
*
* @defaultValue true
*/
immediate?: boolean
/**
* 在计时开始前是否立即执行一次回调函数
*
* @defaultValue false
*/
immediateCallback?: boolean
}
返回值
返回值中包含可暂停、恢复的 Pausable 实例。
更多详情,请参见 Pausable。
export type UseIntervalFnReturns = Pausable