速率限制
函数: rateLimit()
ts
function rateLimit<TFn>(fn, initialOptions): (...args) => boolean
function rateLimit<TFn>(fn, initialOptions): (...args) => boolean
定义于: rate-limiter.ts:404
创建一个速率限制函数，该函数将在指定的时间窗口内最多执行提供的函数次数。
请注意，与节流（throttling）或防抖（debouncing）相比，速率限制是一种更简单的执行控制形式。
- 速率限制器将允许所有执行，直到达到限制，然后阻止所有后续调用，直到窗口重置。
- 节流器可确保执行之间的均匀间隔，这对于保持一致的性能可能更好。
- 防抖器可以将多次调用合并为一次，这对于处理事件突发事件更好。
速率限制器支持两种类型的窗口
- 'fixed': 一个严格的窗口，在窗口期后重置。窗口内的所有执行都会计入限制，并且窗口会在期满后完全重置。
- 'sliding': 一个滚动窗口，允许在旧的执行过期时进行新的执行。这提供了更一致的执行速率。
状态管理
- 使用 TanStack Store 进行响应式状态管理
- 使用 initialState 在创建速率限制器时提供初始状态值
- 使用 onExecute 回调来响应函数执行并实现自定义逻辑
- 使用 onReject 回调函数来响应在超出速率限制时被拒绝的执行
- 状态包括执行次数、执行时间和拒绝次数。
- 可以通过底层 RateLimiter 实例的 store.state 属性访问状态。
- 在使用框架适配器（React/Solid）时，状态从 hook 的 state 属性访问
如果您需要更智能的执行控制，请考虑使用 throttle() 或 debounce()。当您特别需要强制执行在特定时间段内的执行次数硬限制时，请使用速率限制。
类型参数
• TFn extends AnyFunction
参数
fn
TFn
initialOptions
RateLimiterOptions<TFn>
Returns (返回)
Function
尝试在配置的限制内执行速率限制函数。如果当前窗口中的调用次数超过限制，则会拒绝执行。
参数
args
...Parameters<TFn>
Returns (返回)
boolean
示例
ts
const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });
// First 5 calls will return true
rateLimiter.maybeExecute('arg1', 'arg2'); // true
// Additional calls within the window will return false
rateLimiter.maybeExecute('arg1', 'arg2'); // false
const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });
// First 5 calls will return true
rateLimiter.maybeExecute('arg1', 'arg2'); // true
// Additional calls within the window will return false
rateLimiter.maybeExecute('arg1', 'arg2'); // false
示例
ts
// Rate limit to 5 calls per minute with a sliding window
const rateLimited = rateLimit(makeApiCall, {
limit: 5,
window: 60000,
windowType: 'sliding',
onReject: (rateLimiter) => {
console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
}
});
// First 5 calls will execute immediately
// Additional calls will be rejected until the minute window resets
rateLimited();
// For more even execution, consider using throttle instead:
const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
// Rate limit to 5 calls per minute with a sliding window
const rateLimited = rateLimit(makeApiCall, {
limit: 5,
window: 60000,
windowType: 'sliding',
onReject: (rateLimiter) => {
console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
}
});
// First 5 calls will execute immediately
// Additional calls will be rejected until the minute window resets
rateLimited();
// For more even execution, consider using throttle instead:
const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
我们的合作伙伴
订阅 Bytes
您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。
订阅 Bytes
您的每周 JavaScript 资讯。每周一免费发送给超过 10 万开发者。