Class RateCounter

constructor

• new RateCounter(_windowMs: number, Max: number, _maxKeys?: number): RateCounter

  Parameters

  • _windowMs: number
  • Max: number
  • _maxKeys: number = 10_000

  Returns RateCounter

Max

Size

• get Size(): number

  Number of keys tracked now.

  Returns number

Clear

• Clear(): void

  Returns void

Hit

• Hit(key: string, now?: number): boolean

  Counts one hit for key. Returns false when the key was already over its budget.

  Parameters

  • key: string
  • now: number = ...

  Returns boolean

IsOver

• IsOver(key: string, now?: number): boolean

  True when key has used its budget in the current window.

  Parameters

  • key: string
  • now: number = ...

  Returns boolean

Sweep

• Sweep(now?: number): void

  Removes keys whose window has ended.

  Parameters

  • now: number = ...

  Returns void