Class RateLimiter

constructor

• new RateLimiter(opts?: RateLimiterInit): RateLimiter

  Parameters

  • opts: RateLimiterInit = {}

  Returns RateLimiter

ReadonlymemoryStorage

block

• block(key: string, secDuration: number): RateLimiterResult

  Block any key for secDuration seconds

  Parameters

  • key: string
  • secDuration: number

  Returns RateLimiterResult

consume

• consume(
      key: string,
      pointsToConsume?: number,
      options?: GetKeySecDurationOptions,
  ): Promise<RateLimiterResult>

  Parameters

  • key: string
  • pointsToConsume: number = 1
  • options: GetKeySecDurationOptions = {}

  Returns Promise<RateLimiterResult>

delete

• delete(key: string): void

  Parameters

  • key: string

  Returns void

get

• get(key: string): undefined | RateLimiterResult

  Parameters

  • key: string

  Returns undefined | RateLimiterResult

getKey

• getKey(key: string): string

  Parameters

  • key: string

  Returns string

parseKey

• parseKey(rlKey: string): string

  Parameters

  • rlKey: string

  Returns string

penalty

• penalty(
      key: string,
      points?: number,
      options?: GetKeySecDurationOptions,
  ): RateLimiterResult

  Parameters

  • key: string
  • points: number = 1
  • options: GetKeySecDurationOptions = {}

  Returns RateLimiterResult

reward

• reward(
      key: string,
      points?: number,
      options?: GetKeySecDurationOptions,
  ): RateLimiterResult

  Parameters

  • key: string
  • points: number = 1
  • options: GetKeySecDurationOptions = {}

  Returns RateLimiterResult

set

• set(key: string, points: number, secDuration?: number): RateLimiterResult

  Parameters

  • key: string
  • points: number
  • secDuration: number = 0

  Returns RateLimiterResult