Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RateLimiter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new RateLimiter(config: ConfigInterface["rate-limit"]): RateLimiter

Properties

Readonly config

config: ConfigInterface["rate-limit"]

Methods

Abstract schedule

  • schedule<T>(request: () => Promise<T>, region?: Region): Promise<T>
  • Schedule a promise through the specified regional rate limiter.

    Type parameters

    • T

    Parameters

    • request: () => Promise<T>

      A function returning a request Promise.

        • (): Promise<T>
        • Returns Promise<T>

    • Optional region: Region

      The regional rate limiter to schedule the request under.

    Returns Promise<T>

    Another promise which executes after rate limit delays finish.