函数：createRateLimitedSignal()

function createRateLimitedSignal<TValue, TSelected>(
   value, 
   initialOptions, 
   selector?): [Accessor<TValue>, Setter<TValue>, SolidRateLimiter<Setter<TValue>, TSelected>]

function createRateLimitedSignal<TValue, TSelected>(
   value, 
   initialOptions, 
   selector?): [Accessor<TValue>, Setter<TValue>, SolidRateLimiter<Setter<TValue>, TSelected>]

定义于：rate-limiter/createRateLimitedSignal.ts:95

一个 Solid hook，用于创建一个速率限制的状态值，该状态值强制执行在时间窗口内状态更新的硬限制。此 hook 将 Solid 的 createSignal 与速率限制功能结合起来，提供受控的状态更新。

速率限制是一种简单的“硬限制”方法——它允许所有更新直到达到限制，然后阻止后续更新直到窗口重置。与节流或防抖不同，它不尝试分散或智能地合并更新。这可能导致快速更新的爆发，然后是无更新的时期。

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

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

为了更平滑的更新模式，请考虑使用

createThrottledSignal：当你想要更新之间保持一致的间隔时（例如，UI 更改）
createDebouncedSignal：当你想要将快速更新合并为单个更新时（例如，搜索输入）

速率限制主要用于需要强制执行严格限制的情况，例如 API 速率限制。

该 hook 返回一个元组，包含：

速率限制状态值的访问器
一个速率限制的设置函数，它会遵守配置的限制
用于额外控制的 rateLimiter 实例

为了在没有状态管理的情况下直接控制速率限制，可以考虑使用更底层的 createRateLimiter hook。

状态管理和选择器

该 hook 使用 TanStack Store 通过底层的 rate limiter 实例进行响应式状态管理。selector 参数允许你指定哪些 rate limiter 状态更改会触发响应式更新，通过防止不必要的订阅（当不相关的状态发生更改时）来优化性能。

默认情况下，将不会有响应式状态订阅，你必须通过提供一个 selector 函数来选择加入状态跟踪。这可以防止不必要的响应式更新，并让你完全控制组件何时订阅状态更改。只有当你提供一个 selector 时，响应式系统才会跟踪选定的状态值。

可用的速率限制器状态属性

callsInWindow：当前窗口中执行的调用次数
remainingInWindow：当前窗口中剩余的调用次数
windowStart：当前窗口开始的 Unix 时间戳
nextWindowStart：下一个窗口开始的 Unix 时间戳
msUntilNextWindow：距离下一个窗口开始的毫秒数
isAtLimit：当前窗口的调用限制是否已达到
status：当前状态（“disabled” | “idle” | “at-limit”）

// Default behavior - no reactive state subscriptions
const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {
  limit: 5,
  window: 60000,
  windowType: 'sliding'
});

// Opt-in to reactive updates when limit state changes (optimized for UI feedback)
const [value, setValue, rateLimiter] = createRateLimitedSignal(
  0,
  { limit: 5, window: 60000 },
  (state) => ({ isAtLimit: state.isAtLimit, remainingInWindow: state.remainingInWindow })
);

// With rejection callback and fixed window
const [value, setValue] = createRateLimitedSignal(0, {
  limit: 3,
  window: 5000,
  windowType: 'fixed',
  onReject: (rateLimiter) => {
    alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  }
});

// Access rateLimiter state via signals
const handleSubmit = () => {
  const remaining = rateLimiter.state().remainingInWindow;
  if (remaining > 0) {
    setValue(newValue);
  } else {
    showRateLimitWarning();
  }
};

// Default behavior - no reactive state subscriptions
const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {
  limit: 5,
  window: 60000,
  windowType: 'sliding'
});

// Opt-in to reactive updates when limit state changes (optimized for UI feedback)
const [value, setValue, rateLimiter] = createRateLimitedSignal(
  0,
  { limit: 5, window: 60000 },
  (state) => ({ isAtLimit: state.isAtLimit, remainingInWindow: state.remainingInWindow })
);

// With rejection callback and fixed window
const [value, setValue] = createRateLimitedSignal(0, {
  limit: 3,
  window: 5000,
  windowType: 'fixed',
  onReject: (rateLimiter) => {
    alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  }
});

// Access rateLimiter state via signals
const handleSubmit = () => {
  const remaining = rateLimiter.state().remainingInWindow;
  if (remaining > 0) {
    setValue(newValue);
  } else {
    showRateLimitWarning();
  }
};

createRateLimitedSignal

函数：createRateLimitedSignal()

状态管理和选择器

类型参数

参数

value

initialOptions

选择器?

Returns (返回)

示例

订阅 Bytes

订阅 Bytes