Add Message Component Interaction Typeguards

discordjs · Mar 4, 2022 · d6d72de · d6d72de
1 parent c85958e
commit d6d72de
Show file tree

Hide file tree

Showing 4 changed files with 108 additions and 0 deletions.
diff --git a/deno/utils/v10.ts b/deno/utils/v10.ts
@@ -10,11 +10,14 @@ import {
 	APIDMInteraction,
 	APIGuildInteraction,
 	APIInteraction,
+	APIMessageComponentButtonInteraction,
 	APIMessageComponentDMInteraction,
 	APIMessageComponentGuildInteraction,
 	APIMessageComponentInteraction,
+	APIMessageComponentSelectMenuInteraction,
 	ApplicationCommandType,
 	ButtonStyle,
+	ComponentType,
 } from '../payloads/v10/mod.ts';
 
 // Interactions
@@ -105,6 +108,30 @@ export function isInteractionButton(component: APIButtonComponent): component is
 	return component.style !== ButtonStyle.Link;
 }
 
+// Message Components
+
+/**
+ * A type-guard check for button message component interactions
+ * @param interaction The message component interaction to check against
+ * @returns A boolean that indicates if the message component is a button
+ */
+export function isMessageComponentButtonInteraction(
+	interaction: APIMessageComponentInteraction,
+): interaction is APIMessageComponentButtonInteraction {
+	return interaction.data.component_type === ComponentType.Button;
+}
+
+/**
+ * A type-guard check for select menu message component interactions
+ * @param interaction The message component interaction to check against
+ * @returns A boolean that indicates if the message component is a select menu
+ */
+export function isMessageComponentSelectMenuInteraction(
+	interaction: APIMessageComponentInteraction,
+): interaction is APIMessageComponentSelectMenuInteraction {
+	return interaction.data.component_type === ComponentType.SelectMenu;
+}
+
 // Application Commands
 
 /**

diff --git a/deno/utils/v9.ts b/deno/utils/v9.ts
@@ -10,11 +10,14 @@ import {
 	APIDMInteraction,
 	APIGuildInteraction,
 	APIInteraction,
+	APIMessageComponentButtonInteraction,
 	APIMessageComponentDMInteraction,
 	APIMessageComponentGuildInteraction,
 	APIMessageComponentInteraction,
+	APIMessageComponentSelectMenuInteraction,
 	ApplicationCommandType,
 	ButtonStyle,
+	ComponentType,
 } from '../payloads/v9/mod.ts';
 
 // Interactions
@@ -105,6 +108,30 @@ export function isInteractionButton(component: APIButtonComponent): component is
 	return component.style !== ButtonStyle.Link;
 }
 
+// Message Components
+
+/**
+ * A type-guard check for button message component interactions
+ * @param interaction The message component interaction to check against
+ * @returns A boolean that indicates if the message component is a button
+ */
+export function isMessageComponentButtonInteraction(
+	interaction: APIMessageComponentInteraction,
+): interaction is APIMessageComponentButtonInteraction {
+	return interaction.data.component_type === ComponentType.Button;
+}
+
+/**
+ * A type-guard check for select menu message component interactions
+ * @param interaction The message component interaction to check against
+ * @returns A boolean that indicates if the message component is a select menu
+ */
+export function isMessageComponentSelectMenuInteraction(
+	interaction: APIMessageComponentInteraction,
+): interaction is APIMessageComponentSelectMenuInteraction {
+	return interaction.data.component_type === ComponentType.SelectMenu;
+}
+
 // Application Commands
 
 /**

diff --git a/utils/v10.ts b/utils/v10.ts
@@ -10,11 +10,14 @@ import {
 	APIDMInteraction,
 	APIGuildInteraction,
 	APIInteraction,
+	APIMessageComponentButtonInteraction,
 	APIMessageComponentDMInteraction,
 	APIMessageComponentGuildInteraction,
 	APIMessageComponentInteraction,
+	APIMessageComponentSelectMenuInteraction,
 	ApplicationCommandType,
 	ButtonStyle,
+	ComponentType,
 } from '../payloads/v10/index';
 
 // Interactions
@@ -105,6 +108,30 @@ export function isInteractionButton(component: APIButtonComponent): component is
 	return component.style !== ButtonStyle.Link;
 }
 
+// Message Components
+
+/**
+ * A type-guard check for button message component interactions
+ * @param interaction The message component interaction to check against
+ * @returns A boolean that indicates if the message component is a button
+ */
+export function isMessageComponentButtonInteraction(
+	interaction: APIMessageComponentInteraction,
+): interaction is APIMessageComponentButtonInteraction {
+	return interaction.data.component_type === ComponentType.Button;
+}
+
+/**
+ * A type-guard check for select menu message component interactions
+ * @param interaction The message component interaction to check against
+ * @returns A boolean that indicates if the message component is a select menu
+ */
+export function isMessageComponentSelectMenuInteraction(
+	interaction: APIMessageComponentInteraction,
+): interaction is APIMessageComponentSelectMenuInteraction {
+	return interaction.data.component_type === ComponentType.SelectMenu;
+}
+
 // Application Commands
 
 /**

diff --git a/utils/v9.ts b/utils/v9.ts
@@ -10,11 +10,14 @@ import {
 	APIDMInteraction,
 	APIGuildInteraction,
 	APIInteraction,
+	APIMessageComponentButtonInteraction,
 	APIMessageComponentDMInteraction,
 	APIMessageComponentGuildInteraction,
 	APIMessageComponentInteraction,
+	APIMessageComponentSelectMenuInteraction,
 	ApplicationCommandType,
 	ButtonStyle,
+	ComponentType,
 } from '../payloads/v9/index';
 
 // Interactions
@@ -105,6 +108,30 @@ export function isInteractionButton(component: APIButtonComponent): component is
 	return component.style !== ButtonStyle.Link;
 }
 
+// Message Components
+
+/**
+ * A type-guard check for button message component interactions
+ * @param interaction The message component interaction to check against
+ * @returns A boolean that indicates if the message component is a button
+ */
+export function isMessageComponentButtonInteraction(
+	interaction: APIMessageComponentInteraction,
+): interaction is APIMessageComponentButtonInteraction {
+	return interaction.data.component_type === ComponentType.Button;
+}
+
+/**
+ * A type-guard check for select menu message component interactions
+ * @param interaction The message component interaction to check against
+ * @returns A boolean that indicates if the message component is a select menu
+ */
+export function isMessageComponentSelectMenuInteraction(
+	interaction: APIMessageComponentInteraction,
+): interaction is APIMessageComponentSelectMenuInteraction {
+	return interaction.data.component_type === ComponentType.SelectMenu;
+}
+
 // Application Commands
 
 /**