Class RateLimiter<T, U, V>Abstract

constructor

• new RateLimiter<T, U, V>(fn, limit?): RateLimiter<T, U, V>

• Instantiate a rate limiter.

  Type Parameters

  • T
  • U
  • V extends any[]

  Parameters

  • fn: ((...args) => T | Promise<T>)

    The function to rate limit.

    • • (...args): T | Promise<T>

      • Parameters

        • Rest ...args: V

        Returns T | Promise<T>

  • limit: number = 500

    The rate limit; defaults to 500ms.

  Returns RateLimiter<T, U, V>

Readonly limit

isDisposed

• get isDisposed(): boolean

• Whether the rate limiter is disposed.

  Returns boolean

dispose

• dispose(): void

• Disposes the rate limiter.

  Returns void

Abstract invoke

• invoke(...args): Promise<T>

• Invoke the rate limited function.

  Parameters

  • Rest ...args: V

  Returns Promise<T>

stop

• stop(): Promise<void>

• Stop the function if it is mid-flight.

  Returns Promise<void>