From f4d3f4d5b1c1b6e42c2a8f8184f43d67b586c8c1 Mon Sep 17 00:00:00 2001 From: Almeida Date: Wed, 14 Sep 2022 19:13:32 +0100 Subject: [PATCH] feat: add `RESTRateLimit` (#585) --- deno/payloads/common.ts | 18 ++++++++++++++++++ payloads/common.ts | 18 ++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/deno/payloads/common.ts b/deno/payloads/common.ts index 95dfade74..52aa979ad 100644 --- a/deno/payloads/common.ts +++ b/deno/payloads/common.ts @@ -78,3 +78,21 @@ export interface RESTErrorGroupWrapper { } export type RESTErrorData = RESTErrorGroupWrapper | RESTErrorFieldInformation | { [k: string]: RESTErrorData } | string; + +/** + * https://discord.com/developers/docs/topics/rate-limits#exceeding-a-rate-limit-rate-limit-response-structure + */ +export interface RESTRateLimit { + /** + * A value indicating if you are being globally rate limited or not + */ + global: boolean; + /** + * A message saying you are being rate limited. + */ + message: string; + /** + * The number of seconds to wait before submitting another request. + */ + retry_after: number; +} diff --git a/payloads/common.ts b/payloads/common.ts index 5747c9999..e3382f76d 100644 --- a/payloads/common.ts +++ b/payloads/common.ts @@ -78,3 +78,21 @@ export interface RESTErrorGroupWrapper { } export type RESTErrorData = RESTErrorGroupWrapper | RESTErrorFieldInformation | { [k: string]: RESTErrorData } | string; + +/** + * https://discord.com/developers/docs/topics/rate-limits#exceeding-a-rate-limit-rate-limit-response-structure + */ +export interface RESTRateLimit { + /** + * A value indicating if you are being globally rate limited or not + */ + global: boolean; + /** + * A message saying you are being rate limited. + */ + message: string; + /** + * The number of seconds to wait before submitting another request. + */ + retry_after: number; +}