RateLimiter

类：RateLimiter<TFn>

定义于：rate-limiter.ts:80

一个创��速率限制函数的类。

速率限制是一种简单的方法，它允许函数在时间窗口内执行达到限制的次数，然后阻止所有后续调用，直到窗口过去。这可能导致“突发”行为，即所有执行立即发生，然后是完全阻塞。

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

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

对于更平滑的执行模式，请考虑使用：

节流：确保执行之间具有一致的间距（例如，每 200 毫秒最多一次）
防抖：在执行前等待调用暂停（例如，在没有调用 500 毫秒后）

速率限制最适合用于硬 API 限制或资源约束。对于 UI 更新或平滑频繁事件，节流或防抖通常提供更好的用户体验。

示例

const rateLimiter = new RateLimiter(
  (id: string) => api.getData(id),
  { limit: 5, window: 1000, windowType: 'sliding' } // 滑动窗口内每秒 5 次调用
);

// 将立即执行直到达到限制，然后阻塞
rateLimiter.maybeExecute('123');

const rateLimiter = new RateLimiter(
  (id: string) => api.getData(id),
  { limit: 5, window: 1000, windowType: 'sliding' } // 滑动窗口内每秒 5 次调用
);

// 将立即执行直到达到限制，然后阻塞
rateLimiter.maybeExecute('123');

类型参数

• TFn extends AnyFunction

构造函数

new RateLimiter()

new RateLimiter<TFn>(fn, initialOptions): RateLimiter<TFn>

new RateLimiter<TFn>(fn, initialOptions): RateLimiter<TFn>

定义于：rate-limiter.ts:86

参数

fn

TFn

initialOptions

RateLimiterOptions<TFn>

RateLimiter<TFn>

方法

getEnabled()

getEnabled(): boolean

getEnabled(): boolean

定义于：rate-limiter.ts:113

返回速率限制器的当前启用状态

boolean

getExecutionCount()

getExecutionCount(): number

getExecutionCount(): number

定义于：rate-limiter.ts:198

返回函数已执行的次数

number

getLimit()

getLimit(): number

getLimit(): number

定义于：rate-limiter.ts:120

返回时间窗口内允许的当前执行限制

number

getMsUntilNextWindow()

getMsUntilNextWindow(): number

getMsUntilNextWindow(): number

定义于：rate-limiter.ts:220

返回距离下一次可能执行的毫秒数

number

getOptions()

getOptions(): Required<RateLimiterOptions<TFn>>

getOptions(): Required<RateLimiterOptions<TFn>>

定义于：rate-limiter.ts:106

返回当前速率限制器选项

Required<RateLimiterOptions<TFn>>

getRejectionCount()

getRejectionCount(): number

getRejectionCount(): number

定义于：rate-limiter.ts:205

返回函数被拒绝的次数

number

getRemainingInWindow()

getRemainingInWindow(): number

getRemainingInWindow(): number

定义于：rate-limiter.ts:212

返回当前窗口中允许的剩余执行次数

number

getWindow()

getWindow(): number

getWindow(): number

定义于：rate-limiter.ts:127

返回当前时间窗口（以毫秒为单位）

number

maybeExecute()

maybeExecute(...args): boolean

maybeExecute(...args): boolean

定义于：rate-limiter.ts:146

如果符合配置的限制，则尝试执行速率限制函数。如果当前窗口中的调用次数超出限制，则将拒绝执行。

参数

args

...Parameters<TFn>

boolean

示例

const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });

// 前 5 次调用将返回 true
rateLimiter.maybeExecute('arg1', 'arg2'); // true

// 窗口内的其他调用将返回 false
rateLimiter.maybeExecute('arg1', 'arg2'); // false

const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });

// 前 5 次调用将返回 true
rateLimiter.maybeExecute('arg1', 'arg2'); // true

// 窗口内的其他调用将返回 false
rateLimiter.maybeExecute('arg1', 'arg2'); // false

reset()

reset(): void

reset(): void

定义于：rate-limiter.ts:231

重置速率限制器状态

void

setOptions()

setOptions(newOptions): void

setOptions(newOptions): void

定义于：rate-limiter.ts:99

更新速率限制器选项

参数

newOptions

Partial<RateLimiterOptions<TFn>>

void