Class CreditRateLimiter

Index

Constructors

Methods

available cost tryAcquire

Constructors

constructor

new CreditRateLimiter(config: RateLimiterConfig): CreditRateLimiter
Parameters
- config: RateLimiterConfig
Returns CreditRateLimiter
- Defined in src/rpc/rate-limit.ts:40

Methods

available

available(): number
Credits currently available (after refill).

Returns number
- Defined in src/rpc/rate-limit.ts:78

cost

cost(method: string): number
Credit cost of a method under the configured weights.
Parameters
- method: string
Returns number
- Defined in src/rpc/rate-limit.ts:50

tryAcquire

tryAcquire(method: string): boolean
Attempts to spend credits for method; returns false if the bucket is dry.
Parameters
- method: string
Returns boolean
- Defined in src/rpc/rate-limit.ts:67