Skip to content
On this page

useInterval

处理 setInterval 的 Hook。

代码演示

API

useInterval(
  fn: () => void,
  delay?: number | undefined,
  options?: Options
): fn: () => void;
useInterval(
  fn: () => void,
  delay?: number | undefined,
  options?: Options
): fn: () => void;

Params

参数说明类型
fn要定时调用的函数() => void
delay间隔时间,当取值 undefined 时会停止计时器Ref<number>|number | undefined
options配置计时器的行为Options

Options

参数说明类型默认值
immediate是否在首次渲染时立即执行booleanfalse

Result

参数说明类型
clear清除定时器() => void
restart重新启动定时器() => void

Source

源码文档示例