Polling Utility

简介

这是一个简单 JavaScript 轮询工具，适用于定期执行某个函数，比如拉取数据、监测状态等。

安装

通过 npm 安装：

npm install polling-utils

使用

import { usePolling } from "polling-utils";

// 定义轮询函数
const fetchData = async (id) => {
  console.log("正在获取 ID:", id, "的数据...");
  // 模拟 API 请求
};

const { startPolling, stopPolling } = usePolling(fetchData, 3000, true);

// 启动轮询（每 3 秒执行一次）
startPolling(123);

// 5 秒后停止轮询
setTimeout(() => stopPolling(), 5000);

📚 API 说明

usePolling(pollFn, interval, immediate)

参数 类型 默认值 说明

pollFn function - 需要执行的轮询函数

interval number 5000 轮询的时间间隔（单位：毫秒）

immediate boolean false 是否在启动时立即执行一次

返回值

usePolling 返回一个对象，包含以下两个方法：

1️⃣ startPolling(id)

作用：启动轮询，并将 id 传递给 pollFn 。 示例： startPolling(42); // 立即执行一次 fetchData(42)，然后每 5 秒执行一次

2️⃣ stopPolling()

作用：手动停止轮询。 示例： stopPolling(); // 停止轮询

🎯 应用场景

✅ 定期拉取数据（如定时请求 API） ✅ 检测任务状态（如轮询某个异步任务的完成情况） ✅ 自动刷新页面数据（如聊天消息、股票行情等）