Skip to content

RateLimitHeaders

Defined in: packages/rest/src/headers.ts:5

A response’s rate-limit headers, each one validated on its own.

optional bucket?: string

Defined in: packages/rest/src/headers.ts:15

X-RateLimit-Bucket: the server’s bucket hash.


global: boolean

Defined in: packages/rest/src/headers.ts:19

X-RateLimit-Global: true.


optional limit?: number

Defined in: packages/rest/src/headers.ts:7

X-RateLimit-Limit: requests per window.


optional remaining?: number

Defined in: packages/rest/src/headers.ts:9

X-RateLimit-Remaining: requests left in the window.


optional resetAfterMs?: number

Defined in: packages/rest/src/headers.ts:11

X-RateLimit-Reset-After, in ms from now.


optional resetAtMs?: number

Defined in: packages/rest/src/headers.ts:13

X-RateLimit-Reset, as epoch ms: identifies the window.


optional retryAfterMs?: number

Defined in: packages/rest/src/headers.ts:21

Retry-After, in ms.


optional scope?: RateLimitScope

Defined in: packages/rest/src/headers.ts:17

X-RateLimit-Scope, when it is one Discord documents.