useTimeout Hook 使用说明
功能概述
useTimeout 是一个 React Hook,用于管理 setTimeout 定时器,提供启动、清除和状态跟踪功能,比原生 setTimeout 更安全易用。
基础用法
import { useTimeout } from './useTimeout';
function Notification() {
const { start, clear } = useTimeout(() => console.log('3秒后执行'), 3000);
return (
<div>
<button onClick={start}>开始计时</button>
<button onClick={clear}>取消计时</button>
</div>
);
}
API 说明
输入参数
| 参数 |
类型 |
必填 |
默认值 |
说明 |
| callback |
() => void |
是 |
- |
定时器回调函数 |
| delay |
number \| null |
是 |
- |
延迟时间(ms),设为 null 取消计时 |
| immediate |
boolean |
否 |
false |
是否立即执行一次回调 |
返回值
| 属性 |
类型 |
说明 |
| start |
() => void |
启动定时器 |
| clear |
() => void |
清除定时器 |
| isRunning |
boolean |
定时器是否正在运行 |