Skip to content
On this page

useTimeout

处理 setTimeout 的 Hook。

代码演示

API

useTimeout(
  fn: () => void,
  delay?: Ref<number | undefined> | number,
  options?:{
    immediate?: boolean
  }
): fn: () => void;
useTimeout(
  fn: () => void,
  delay?: Ref<number | undefined> | number,
  options?:{
    immediate?: boolean
  }
): fn: () => void;

Params

参数说明类型
fn待执行函数() => void
delay定时时间(单位为毫秒),支持动态变化,,当取值为 undefined 时会停止计时器Ref<number | undefined >|number | undefined
immediate是否在首次立即执行boolean

Result

参数说明类型
clearTimeout清除定时器() => void

Source

源码文档示例