feat: typings for missing methods and general improvements

discordjs · May 27, 2021 · 33b17a8 · 33b17a8
1 parent b4fd524
commit 33b17a8
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 7 deletions.
diff --git a/src/structures/BaseMessageComponent.js b/src/structures/BaseMessageComponent.js
@@ -9,7 +9,7 @@ class BaseMessageComponent {
   /**
    * Options for a BaseMessageComponent
    * @typedef {Object} BaseMessageComponentOptions
-   * @property {MessageComponentType} type The type of this component
+   * @property {MessageComponentTypeResolvable} type The type of this component
    */
 
   /**
@@ -53,6 +53,12 @@ class BaseMessageComponent {
     return this;
   }
 
+  /**
+   * Constructs a MessageComponent based on the type of the incoming data
+   * @param {MessageComponentOptions} data Data for a MessageComponent
+   * @returns {MessageComponent}
+   * @private
+   */
   static create(data) {
     let component;
     let type = data.type;
@@ -77,7 +83,8 @@ class BaseMessageComponent {
   /**
    * Resolves the type of a MessageComponent
    * @param {MessageComponentTypeResolvable} type The type to resolve
-   * @returns {any}
+   * @returns {MessageComponentType}
+   * @private
    */
   static resolveType(type) {
     return typeof type === 'string' ? type : MessageComponentTypes[type];

diff --git a/src/structures/MessageButton.js b/src/structures/MessageButton.js
@@ -8,7 +8,7 @@ class MessageButton extends BaseMessageComponent {
    * @typedef {BaseMessageComponentOptions} MessageButtonOptions
    * @property {string} [label] The text to be displayed on this button
    * @property {string} [customID] A unique string to be sent in the interaction when clicked
-   * @property {MessageButtonStyle} [style] The style of this button
+   * @property {MessageButtonStyleResolvable} [style] The style of this button
    * @property {Emoji} [emoji] The emoji to be displayed to the left of the text
    * @property {string} [url] Optional URL for link-style buttons
    * @property {boolean} [disabled=false] Disables the button to prevent interactions
@@ -103,7 +103,7 @@ class MessageButton extends BaseMessageComponent {
 
   /**
    * Sets the style of this button
-   * @param {MessageButtonStyle} style The style of this button
+   * @param {MessageButtonStyleResolvable} style The style of this button
    * @returns {MessageButton}
    */
   setStyle(style) {
@@ -121,6 +121,12 @@ class MessageButton extends BaseMessageComponent {
     return this;
   }
 
+  /**
+   * Resolves the style of a MessageButton
+   * @param {MessageButtonStyleResolvable} style The style to resolve
+   * @returns {MessageButtonStyle}
+   * @private
+   */
   static resolveStyle(style) {
     return typeof style === 'string' ? style : MessageButtonStyles[style];
   }

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -264,7 +264,10 @@ declare module 'discord.js' {
   export class BaseMessageComponent {
     constructor(data?: BaseMessageComponent | BaseMessageComponentOptions);
     public type: MessageComponentType | null;
-    public setType(type: MessageComponentType | number): this;
+    public setType(type: MessageComponentTypeResolvable): this;
+    private static create(data: MessageComponentOptions): MessageComponent;
+    private static resolveType(type: MessageComponentTypeResolvable): MessageComponentType;
+    private static transform(component: MessageComponentResolvable): object;
   }
 
   interface BaseMessageComponentOptions {
@@ -1276,8 +1279,9 @@ declare module 'discord.js' {
     public setDisabled(disabled: boolean): this;
     public setEmoji(emoji: EmojiIdentifierResolvable): this;
     public setLabel(label: string): this;
-    public setStyle(style: MessageButtonStyle | MessageButtonStyles): this;
+    public setStyle(style: MessageButtonStyleResolvable): this;
     public setURL(url: string): this;
+    private static resolveStyle(style: MessageButtonStyleResolvable): MessageButtonStyle;
   }
 
   export class MessageCollector extends Collector<Snowflake, Message> {
@@ -3234,12 +3238,15 @@ declare module 'discord.js' {
     disabled?: boolean;
     emoji?: RawEmoji;
     label?: string;
-    style?: MessageButtonStyle | MessageButtonStyles;
+    style: MessageButtonStyleResolvable;
+    type: 'BUTTON' | MessageComponentTypes.BUTTON;
     url?: string;
   }
 
   type MessageButtonStyle = keyof typeof MessageButtonStyles;
 
+  type MessageButtonStyleResolvable = MessageButtonStyle | MessageButtonStyles | string | number;
+
   interface MessageCollectorOptions extends CollectorOptions {
     max?: number;
     maxProcessed?: number;
@@ -3253,6 +3260,8 @@ declare module 'discord.js' {
 
   type MessageComponentType = keyof typeof MessageComponentTypes;
 
+  type MessageComponentTypeResolvable = MessageComponentType | MessageComponentTypes | string | number;
+
   interface MessageEditOptions {
     content?: StringResolvable;
     embed?: MessageEmbed | MessageEmbedOptions | null;