React ahooks——副作用类hooks之useThrottleFn

**useThrottleFn**用于创建一个节流函数,确保该函数在指定时间内最多执行一次。

一、基本使用

javascript 复制代码
import { useThrottleFn } from 'ahooks';
import { Button, Space } from 'antd';

const ThrottleDemo = () => {
  const { run, cancel, flush } = useThrottleFn(
    (message) => {
      console.log(message, new Date().toISOString());
    },
    { 
      wait: 2000,
      leading: true,
      trailing: true 
    }
  );

  return (
    <Space>
      <Button onClick={() => run('常规调用')}>触发节流函数</Button>
      <Button onClick={cancel}>取消待执行</Button>
      <Button onClick={flush}>立即执行待调用</Button>
    </Space>
  );
};

二、参数说明

2.1 配置项

**useThrottleFn**的第二个参数是一个配置对象,可以设置以下选项:

主要配置项

  • wait (number)

    • 节流等待时间,单位毫秒

    • 默认值:1000 (1秒)

    • 示例:{ wait: 500 } 表示500毫秒内最多执行一次

  • leading (boolean)

    • 是否在节流开始前立即执行函数

    • 默认值:true

    • 如果设为 false,第一次调用不会立即执行

  • trailing (boolean)

    • 是否在节流结束后执行函数

    • 默认值:true

    • 如果设为 false,最后一次调用不会在延迟结束后执行

高级配置项

  • maxWait (number)

    • 最大等待时间,保证在超过此时间后一定会执行一次

    • 示例:{ wait: 500, maxWait: 2000 } 表示即使持续触发,至少每2秒会执行一次

2.2 返回值

run (Function)

  • 触发执行节流函数的入口

  • 调用时会根据配置的节流规则决定是否执行原函数

  • 可以传递参数给原函数

cancel (Function)

  • 取消所有待执行的节流函数调用

  • 清空节流计时器

flush (Function)

  • 立即执行当前待执行的节流函数(如果有)

  • 不会重置节流计时器

相关推荐
烛阴13 分钟前
Ceil -- 从平滑到阶梯
前端·webgl
90后的晨仔23 分钟前
🔍Vue 模板引用(Template Refs)全解析:当你必须操作 DOM 时
前端·vue.js
90后的晨仔24 分钟前
👂 Vue 侦听器(watch)详解:监听数据的变化
前端·vue.js
90后的晨仔43 分钟前
深入浅出 Vue 的 computed:不仅仅是“计算属性”那么简单!
前端·vue.js
Nan_Shu_6141 小时前
学习:入门uniapp Vue3组合式API版本(17)
前端·vue.js·学习·uni-app
止观止1 小时前
Remix框架:高性能React全栈开发实战
前端·react.js·前端框架·remix
萌萌哒草头将军2 小时前
🚀🚀🚀 深入探索 Node.js v22.18.0 新特性;默认支持运行 ts 文件了!
前端·typescript·node.js
秋田君2 小时前
Vue3 + WebSocket网页接入弹窗客服功能的完整实现
前端·javascript·websocket·网络协议·学习
浪里行舟2 小时前
一网打尽 Promise 组合技:race vs any, all vs allSettled,再也不迷糊!
前端·javascript·vue.js