RateLimitHeaders
Defined in: packages/rest/src/headers.ts:5
A response’s rate-limit headers, each one validated on its own.
Properties
Section titled “Properties”bucket?
Section titled “bucket?”
optionalbucket?:string
Defined in: packages/rest/src/headers.ts:15
X-RateLimit-Bucket: the server’s bucket hash.
global
Section titled “global”global:
boolean
Defined in: packages/rest/src/headers.ts:19
X-RateLimit-Global: true.
limit?
Section titled “limit?”
optionallimit?:number
Defined in: packages/rest/src/headers.ts:7
X-RateLimit-Limit: requests per window.
remaining?
Section titled “remaining?”
optionalremaining?:number
Defined in: packages/rest/src/headers.ts:9
X-RateLimit-Remaining: requests left in the window.
resetAfterMs?
Section titled “resetAfterMs?”
optionalresetAfterMs?:number
Defined in: packages/rest/src/headers.ts:11
X-RateLimit-Reset-After, in ms from now.
resetAtMs?
Section titled “resetAtMs?”
optionalresetAtMs?:number
Defined in: packages/rest/src/headers.ts:13
X-RateLimit-Reset, as epoch ms: identifies the window.
retryAfterMs?
Section titled “retryAfterMs?”
optionalretryAfterMs?:number
Defined in: packages/rest/src/headers.ts:21
Retry-After, in ms.
scope?
Section titled “scope?”
optionalscope?:RateLimitScope
Defined in: packages/rest/src/headers.ts:17
X-RateLimit-Scope, when it is one Discord documents.