Skip to content

Commit

Permalink
docs(InteractionResponses): showModal docs change (#9434)
Browse files Browse the repository at this point in the history
* Update InteractionResponses.js

Update the parameters for the showModal method

* Update APITypes.js

Add APIModalInteractionResponseCallbackData link for docs link for showModal method

* Update InteractionResponses.js

Change the order of parameters so the ModalBuilder is listed first

* Update APITypes.js

Disable the ESline line length rule for the APITypes file

* Update InteractionResponses.js

Add ModalComponentData to the JSDoc, it was omitted before.
  • Loading branch information
anandre committed Apr 21, 2023
1 parent b49c5c9 commit 7d34100
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
Expand Up @@ -245,7 +245,7 @@ class InteractionResponses {

/**
* Shows a modal component
* @param {APIModal|ModalData|Modal} modal The modal to show
* @param {ModalBuilder|ModalComponentData|APIModalInteractionResponseCallbackData} modal The modal to show
* @returns {Promise<void>}
*/
async showModal(modal) {
Expand Down
7 changes: 7 additions & 0 deletions packages/discord.js/src/util/APITypes.js
@@ -1,3 +1,5 @@
/* eslint-disable max-len */

/**
* @external ActivityFlags
* @see {@link https://discord-api-types.dev/api/discord-api-types-v10/enum/ActivityFlags}
Expand Down Expand Up @@ -133,6 +135,11 @@
* @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/APIModalInteractionResponse}
*/

/**
* @external APIModalInteractionResponseCallbackData
* @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/APIModalInteractionResponseCallbackData}
*/

/**
* @external APIModalComponent
* @see {@link https://discord-api-types.dev/api/discord-api-types-v10#APIModalComponent}
Expand Down

0 comments on commit 7d34100

Please sign in to comment.