useTimeoutFn
可取消的 setTimeout
Usage
实时编辑器
function Demo() { const [text, setText] = useState("请等待3秒"); const [isPending, start] = useTimeoutFn( () => { setText("触发了!"); }, 3000, { immediate: false }, ); return ( <div> <p>{text}</p> <button onClick={() => { setText("请等待3秒"); start(); }} > {isPending ? "等待中" : "重新开始"} </button> </div> ); };
结果
请等待3秒
API
useTimeoutFn
Returns
Stoppable: 包含以下元素的元组:
- 是否等待定时器执行。
- 设置定时器。
- 取消定时器。
Arguments
| 参数名 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| cb | 回调 | (...args: unknown[]) => any (必填) | - |
| interval | 间隔时间 | number (必填) | - |
| options | 可选参数 | UseTimeoutFnOptions | undefined | - |
UseTimeoutFnOptions
| 参数名 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| immediate | 立即设置定时器 | boolean | true |