函数: createRateLimiter()

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

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

定义于: rate-limiter/createRateLimiter.ts:102

一个底层的 Solid hook，用于创建 RateLimiter 实例，以强制执行函数执行的速率限制。

此 hook 设计得非常灵活且独立于状态管理——它只返回一个速率限制器实例，您可以将其集成到任何状态管理解决方案中（createSignal 等）。

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

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

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

为了更平滑的执行模式

当您希望执行之间保持一致的间隔时（例如，UI 更新），请使用节流。
当您希望合并快速触发的事件时（例如，搜索输入框），请使用防抖。
仅当您需要强制执行硬限制时（例如，API 速率限制），才使用速率限制。

状态管理和选择器

该 hook 使用 TanStack Store 进行响应式状态管理。 selector 参数允许您指定哪些状态更改将触发重新渲染，通过防止不相关的状态更改发生不必要的重新渲染来优化性能。

默认情况下，不会有响应式状态订阅，您必须通过提供 selector 函数来选择加入状态跟踪。这可以防止不必要的重新渲染，并让您完全控制组件何时更新。只有当您提供 selector 时，组件才会根据所选状态值的变化而重新渲染。

可用的状态属性

executionCount: 已完成的函数执行次数
rejectionCount: 由于速率限制而被拒绝的函数调用次数
remainingInWindow: 当前窗口中剩余的可执行次数
nextWindowTime: 下一个窗口开始的时间戳
currentWindowStart: 当前窗口开始的时间戳

类型参数

• TFn extends AnyFunction

• TSelected = {}

参数

fn

TFn

initialOptions

RateLimiterOptions<TFn>

选择器

(state) => TSelected

Returns (返回)

SolidRateLimiter<TFn, TSelected>

示例

tsx

// Default behavior - no reactive state subscriptions
const rateLimiter = createRateLimiter(apiCall, {
  limit: 5,
  window: 60000,
  windowType: 'sliding',
  onReject: (rateLimiter) => {
    console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  }
});

// Opt-in to re-render when rate limit state changes (optimized for UI feedback)
const rateLimiter = createRateLimiter(
  apiCall,
  { limit: 5, window: 60000 },
  (state) => ({
    remainingInWindow: state.remainingInWindow,
    rejectionCount: state.rejectionCount
  })
);

// Opt-in to re-render when execution metrics change (optimized for tracking progress)
const rateLimiter = createRateLimiter(
  apiCall,
  { limit: 5, window: 60000 },
  (state) => ({
    executionCount: state.executionCount,
    nextWindowTime: state.nextWindowTime
  })
);

// Access the selected state (will be empty object {} unless selector provided)
const { remainingInWindow, rejectionCount } = rateLimiter.state();

// Default behavior - no reactive state subscriptions
const rateLimiter = createRateLimiter(apiCall, {
  limit: 5,
  window: 60000,
  windowType: 'sliding',
  onReject: (rateLimiter) => {
    console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  }
});

// Opt-in to re-render when rate limit state changes (optimized for UI feedback)
const rateLimiter = createRateLimiter(
  apiCall,
  { limit: 5, window: 60000 },
  (state) => ({
    remainingInWindow: state.remainingInWindow,
    rejectionCount: state.rejectionCount
  })
);

// Opt-in to re-render when execution metrics change (optimized for tracking progress)
const rateLimiter = createRateLimiter(
  apiCall,
  { limit: 5, window: 60000 },
  (state) => ({
    executionCount: state.executionCount,
    nextWindowTime: state.nextWindowTime
  })
);

// Access the selected state (will be empty object {} unless selector provided)
const { remainingInWindow, rejectionCount } = rateLimiter.state();

createRateLimiter