Class BottleneckRateLimiter

Hierarchy

RateLimiter
- BottleneckRateLimiter

Index

Constructors

constructor

Properties

config

Methods

schedule

Constructors

constructor

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

Overrides RateLimiter.constructor
- Defined in galeforce/rate-limiters/bottleneck.ts:13
Parameters
- config: ConfigInterface["rate-limit"]
Returns BottleneckRateLimiter

Properties

Readonly config

config: ConfigInterface["rate-limit"]

Methods

schedule

schedule<T>(request: () => Promise<T>, region?: Region): Promise<T>

Overrides RateLimiter.schedule
- Defined in galeforce/rate-limiters/bottleneck.ts:78
Type parameters
- T
Parameters
- request: () => Promise<T>
  - - (): Promise<T>
    - Returns Promise<T>
- Optional region: Region
Returns Promise<T>