createRateLimiter

函数：createRateLimiter()

function createRateLimiter<TFn>(fn, initialOptions): SolidRateLimiter<TFn>

function createRateLimiter<TFn>(fn, initialOptions): SolidRateLimiter<TFn>

定义于：rate-limiter/createRateLimiter.ts:62

一个低级别的 Solid 钩子，用于创建一个 RateLimiter 实例来强制执行函数执行的速率限制。

此钩子设计灵活且与状态管理无关——它仅返回一个速率限制器实例，您可以将其与任何状态管理解决方案（createSignal 等）集成。

速率限制是一种简单的“硬限制”方法，它允许执行直到在时间窗口内达到最大计数，然后阻止所有后续调用，直到窗口重置。与节流或防抖不同，它不会尝试智能地隔开或折叠执行。

速率限制器支持两种类型的窗口：

'fixed'：一个严格的窗口，在窗口期过后重置。窗口内的所有执行都计入限制，并且窗口在期满后完全重置。
'sliding'：一个滚动窗口，允许随着旧执行的过期而执行。这提供了一个更随时间推移更一致的执行速率。

对于更平滑的执行模式：

当您希望执行之间具有一致的间距时（例如 UI 更新），请使用节流
当您想要折叠快速触发的事件时（例如搜索输入），请使用防抖
仅当您需要强制执行硬限制时（例如 API 速率限制），才使用速率限制

类型参数

• TFn extends AnyFunction

参数

fn

TFn

initialOptions

RateLimiterOptions<TFn>

SolidRateLimiter<TFn>

示例

tsx

// 基本速率限制 - 滑动窗口内每分钟最多调用 5 次
const rateLimiter = createRateLimiter(apiCall, {
  limit: 5,
  window: 60000,
  windowType: 'sliding',
  onReject: (rateLimiter) => {
    console.log(`已超出速率限制。请在 ${rateLimiter.getMsUntilNextWindow()} 毫秒后重试`);
  }
});

// 通过信号访问速率限制器状态
console.log('执行次数：', rateLimiter.executionCount());
console.log('拒绝次数：', rateLimiter.rejectionCount());
console.log('剩余次数：', rateLimiter.remainingInWindow());
console.log('下一个窗口倒计时：', rateLimiter.msUntilNextWindow());

// 基本速率限制 - 滑动窗口内每分钟最多调用 5 次
const rateLimiter = createRateLimiter(apiCall, {
  limit: 5,
  window: 60000,
  windowType: 'sliding',
  onReject: (rateLimiter) => {
    console.log(`已超出速率限制。请在 ${rateLimiter.getMsUntilNextWindow()} 毫秒后重试`);
  }
});

// 通过信号访问速率限制器状态
console.log('执行次数：', rateLimiter.executionCount());
console.log('拒绝次数：', rateLimiter.rejectionCount());
console.log('剩余次数：', rateLimiter.remainingInWindow());
console.log('下一个窗口倒计时：', rateLimiter.msUntilNextWindow());