export interface RateLimitData
Data emitted on RESTEvents.RateLimited
boolean global :
Whether the rate limit that was reached was the global limit
string hash :
The bucket hash for this request
number limit :
The amount of requests we can perform before locking requests
string majorParameter :
The major parameter of the routeFor example, in /channels/x
, this will be x
. If there is no major parameter (e.g: /bot/gateway
) this will be global
.
string method :
The HTTP method being performed
number retryAfter :
The time, in milliseconds, that will need to pass before this specific request can be retried
string route :
The route being hit in this request
The scope of the rate limit that was hit.This can be user
for rate limits that are per client, global
for rate limits that affect all clients or shared
for rate limits that are shared per resource.
number sublimitTimeout :
The time, in milliseconds, that will need to pass before the sublimit lock for the route resets, and requests that fall under a sublimit can be retriedThis is only present on certain sublimits, and 0
otherwise
number timeToReset :
The time, in milliseconds, until the route's request-lock is reset
string url :
The full URL for this request