interface RateLimitData
Data emitted on RESTEvents.RateLimited
externalboolean global :
Whether the rate limit that was reached was the global limit
externalstring hash :
The bucket hash for this request
externalnumber limit :
The amount of requests we can perform before locking requests
externalstring 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
.
externalstring method :
The HTTP method being performed
externalnumber retryAfter :
The time, in milliseconds, that will need to pass before this specific request can be retried
externalstring 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.
externalnumber 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
externalnumber timeToReset :
The time, in milliseconds, until the route's request-lock is reset
externalstring url :
The full URL for this request