feat: add common JSON error types (#568)

discordjs · Aug 19, 2022 · 956f289 · 956f289
1 parent ef8241f
commit 956f289
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/deno/payloads/common.ts b/deno/payloads/common.ts
@@ -58,3 +58,23 @@ export const PermissionFlagsBits = {
 Object.freeze(PermissionFlagsBits);
 
 export type LocalizationMap = Partial<Record<LocaleString, string | null>>;
+
+/**
+ * https://discord.com/developers/docs/topics/opcodes-and-status-codes#json
+ */
+export interface RESTError {
+	code: number;
+	message: string;
+	errors?: RESTErrorData;
+}
+
+export interface RESTErrorFieldInformation {
+	code: string;
+	message: string;
+}
+
+export interface RESTErrorGroupWrapper {
+	_errors: RESTErrorData[];
+}
+
+export type RESTErrorData = RESTErrorGroupWrapper | RESTErrorFieldInformation | { [k: string]: RESTErrorData } | string;
diff --git a/payloads/common.ts b/payloads/common.ts
@@ -58,3 +58,23 @@ export const PermissionFlagsBits = {
 Object.freeze(PermissionFlagsBits);
 
 export type LocalizationMap = Partial<Record<LocaleString, string | null>>;
+
+/**
+ * https://discord.com/developers/docs/topics/opcodes-and-status-codes#json
+ */
+export interface RESTError {
+	code: number;
+	message: string;
+	errors?: RESTErrorData;
+}
+
+export interface RESTErrorFieldInformation {
+	code: string;
+	message: string;
+}
+
+export interface RESTErrorGroupWrapper {
+	_errors: RESTErrorData[];
+}
+
+export type RESTErrorData = RESTErrorGroupWrapper | RESTErrorFieldInformation | { [k: string]: RESTErrorData } | string;