Library referenceClasses
RateLimitTracker
mirrors the X-RateLimit-* headers so a call can be refused before it costs a request
Constructors
Constructor
new RateLimitTracker(): RateLimitTracker;Returns
RateLimitTracker
Methods
blockedFor()
blockedFor(route, now?): number;seconds to wait before a request on this route can succeed, 0 when it may go out now
Parameters
| Parameter | Type |
|---|---|
route | string |
now? | number |
Returns
number
exhaust()
exhaust(
route,
retryAfterSeconds,
now?
): void;a 429 without usable headers still has to block until retry_after passes
Parameters
| Parameter | Type |
|---|---|
route | string |
retryAfterSeconds | number |
now? | number |
Returns
void
observe()
observe(route, headers): RateLimitWindow | null;Parameters
| Parameter | Type |
|---|---|
route | string |
headers | Headers |
Returns
RateLimitWindow | null
snapshot()
snapshot(): RateLimitState;