interface RateLimitData

export interface RateLimitData

Data emitted on RESTEvents.RateLimited

global : boolean

Whether the rate limit that was reached was the global limit

hash : string

The bucket hash for this request

limit : number

The amount of requests we can perform before locking requests

majorParameter : string

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.

method : string

The HTTP method being performed

retryAfter : number

The time, in milliseconds, that will need to pass before this specific request can be retried

route : string

The route being hit in this request

sublimitTimeout : number

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

timeToReset : number

The time, in milliseconds, until the route's request-lock is reset

url : string

The full URL for this request