useTimeoutFn

一个 React Hook,用于创建定时函数。

演示

源码
isActive:
false

用法

请查看 API。

源码

点击下方链接跳转 GitHub 查看源代码。

API

const pausable = useTimeoutFn(handler, interval, options)

函数 Handler

定时器到期时调用的 function

间隔 Interval

定时器的间隔时间(以毫秒为单位)。

选项 Options

export interface UseTimeoutFnOptions {
  /**
   * 调用此函数后立即开始计时器
   *
   * @defaultValue true
   */
  immediate?: boolean
  /**
   * 计时器结束时立即渲染组件
   *
   * 当你需要 `isActive` ref 在计时器结束后立即更新时,将此设置为 `true`
   *
   * @defaultValue false
   */
  updateOnEnd?: boolean
}

返回值

返回值中包含可暂停、恢复的 Pausable 实例。

更多详情,请参见 Pausable

一个可暂停实例 Pausable