docs: add docs for component data

discordjs · Feb 7, 2022 · 3178d2f · 3178d2f
1 parent a1a968d
commit 3178d2f
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 2 deletions.
diff --git a/packages/discord.js/src/util/Components.js b/packages/discord.js/src/util/Components.js
@@ -1,9 +1,52 @@
 'use strict';
 
+/**
+ * @typedef {Object} BaseComponentData
+ * @property {ComponentType} type
+ */
+
+/**
+ * @typedef {BaseComponentData} ActionRowData
+ * @property {ComponentData[]} components
+ */
+
+/**
+ * @typedef {BaseComponentData} ButtonComponentData
+ * @property {ButtonStyle} style
+ * @property {?boolean} disabled
+ * @property {string} label
+ * @property {?APIComponentEmoji} emoji
+ * @property {?string} customId
+ * @property {?string} url
+ */
+
+/**
+ * @typedef {object} SelectMenuComponentOptionData
+ * @property {string} label
+ * @property {string} value
+ * @property {?string} description
+ * @property {?APIComponentEmoji} emoji
+ * @property {?boolean} default
+ */
+
+/**
+ * @typedef {BaseComponentData} SelectMenuComponentData
+ * @property {string} customId
+ * @property {?boolean} disabled
+ * @property {?number} maxValues
+ * @property {?number} minValues
+ * @property {?SelectMenuComponentOptionData[]} options
+ * @property {?string} placeholder
+ */
+
+/**
+ * @typedef {ActionRowData|ButtonComponentData|SelectMenuComponentData} ComponentData
+ */
+
 class Components extends null {
   /**
    * Transforms json data into api-compatible json data.
-   * @param {MessageComponentData|APIMessageComponent} data The data to transform.
+   * @param {ComponentData|APIMessageComponent} data The data to transform.
    * @returns {APIMessageComponentData}
    */
   static transformJSON(data) {

diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts
@@ -4517,7 +4517,7 @@ export interface MessageActivity {
 
 export interface BaseButtonComponentData extends BaseComponentData {
   disabled?: boolean;
-  emoji?: EmojiIdentifierResolvable;
+  emoji?: APIMessageComponentEmoji;
   label?: string;
 }