feat(RESTErrors): add types for rest errors (#122)

Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>
discordjs · May 25, 2021 · 7b47fc9 · 7b47fc9
1 parent c4e69c9
commit 7b47fc9
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/deno/rest/v8/mod.ts b/deno/rest/v8/mod.ts
@@ -683,3 +683,27 @@ export const OAuth2Routes = {
 
 // Freeze OAuth2 route object
 Object.freeze(OAuth2Routes);
+
+export interface DiscordErrorFieldInformation {
+	code: string;
+	message: string;
+}
+
+export interface DiscordErrorGroupWrapper {
+	_errors: DiscordError[];
+}
+
+export type DiscordErrorData =
+	| DiscordErrorGroupWrapper
+	| DiscordErrorFieldInformation
+	| { [k: string]: DiscordErrorData }
+	| string;
+
+/**
+ * https://discord.com/developers/docs/reference#error-messages
+ */
+export interface DiscordError {
+	code: number;
+	message: string;
+	errors?: DiscordErrorData;
+}
diff --git a/rest/v8/index.ts b/rest/v8/index.ts
@@ -683,3 +683,27 @@ export const OAuth2Routes = {
 
 // Freeze OAuth2 route object
 Object.freeze(OAuth2Routes);
+
+export interface DiscordErrorFieldInformation {
+	code: string;
+	message: string;
+}
+
+export interface DiscordErrorGroupWrapper {
+	_errors: DiscordError[];
+}
+
+export type DiscordErrorData =
+	| DiscordErrorGroupWrapper
+	| DiscordErrorFieldInformation
+	| { [k: string]: DiscordErrorData }
+	| string;
+
+/**
+ * https://discord.com/developers/docs/reference#error-messages
+ */
+export interface DiscordError {
+	code: number;
+	message: string;
+	errors?: DiscordErrorData;
+}