Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-18 12:33:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(InteractionResponse): fix return (#8141)

Browse Source
This commit is contained in:
pat
2022-06-21 07:35:33 -05:00
committed by GitHub
parent db2b0333d9
commit f1ac17c961
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
packages/discord.js/src/structures/interfaces/InteractionResponses.js
View File

@@ -50,7 +50,7 @@ class InteractionResponses {
/** /**
* Defers the reply to this interaction. * Defers the reply to this interaction.
* @param {InteractionDeferReplyOptions} [options] Options for deferring the reply to this interaction * @param {InteractionDeferReplyOptions} [options] Options for deferring the reply to this interaction
* @returns {Promise<Message|APIMessage|InteractionResponse>} * @returns {Promise<Message|InteractionResponse>}
* @example * @example
* // Defer the reply to this interaction * // Defer the reply to this interaction
* interaction.deferReply() * interaction.deferReply()
@@ -83,7 +83,7 @@ class InteractionResponses {
* Creates a reply to this interaction. * Creates a reply to this interaction.
* <info>Use the `fetchReply` option to get the bot's reply message.</info> * <info>Use the `fetchReply` option to get the bot's reply message.</info>
* @param {string|MessagePayload|InteractionReplyOptions} options The options for the reply * @param {string|MessagePayload|InteractionReplyOptions} options The options for the reply
* @returns {Promise<Message|APIMessage|InteractionResponse>} * @returns {Promise<Message|InteractionResponse>}
* @example * @example
* // Reply to the interaction and fetch the response * // Reply to the interaction and fetch the response
* interaction.reply({ content: 'Pong!', fetchReply: true }) * interaction.reply({ content: 'Pong!', fetchReply: true })
@@ -123,7 +123,7 @@ class InteractionResponses {
/** /**
* Fetches the initial reply to this interaction. * Fetches the initial reply to this interaction.
* @see Webhook#fetchMessage * @see Webhook#fetchMessage
* @returns {Promise<Message|APIMessage>} * @returns {Promise<Message>}
* @example * @example
* // Fetch the reply to this interaction * // Fetch the reply to this interaction
* interaction.fetchReply() * interaction.fetchReply()
@@ -138,7 +138,7 @@ class InteractionResponses {
* Edits the initial reply to this interaction. * Edits the initial reply to this interaction.
* @see Webhook#editMessage * @see Webhook#editMessage
* @param {string|MessagePayload|WebhookEditMessageOptions} options The new options for the message * @param {string|MessagePayload|WebhookEditMessageOptions} options The new options for the message
* @returns {Promise<Message|APIMessage>} * @returns {Promise<Message>}
* @example * @example
* // Edit the reply to this interaction * // Edit the reply to this interaction
* interaction.editReply('New content') * interaction.editReply('New content')
@@ -170,7 +170,7 @@ class InteractionResponses {
/** /**
* Send a follow-up message to this interaction. * Send a follow-up message to this interaction.
* @param {string|MessagePayload|InteractionReplyOptions} options The options for the reply * @param {string|MessagePayload|InteractionReplyOptions} options The options for the reply
* @returns {Promise<Message|APIMessage>} * @returns {Promise<Message>}
*/ */
followUp(options) { followUp(options) {
if (!this.deferred && !this.replied) return Promise.reject(new Error(ErrorCodes.InteractionNotReplied)); if (!this.deferred && !this.replied) return Promise.reject(new Error(ErrorCodes.InteractionNotReplied));
@@ -180,7 +180,7 @@ class InteractionResponses {
/** /**
* Defers an update to the message to which the component was attached. * Defers an update to the message to which the component was attached.
* @param {InteractionDeferUpdateOptions} [options] Options for deferring the update to this interaction * @param {InteractionDeferUpdateOptions} [options] Options for deferring the update to this interaction
* @returns {Promise<Message|APIMessage|InteractionResponse>} * @returns {Promise<Message|InteractionResponse>}
* @example * @example
* // Defer updating and reset the component's loading state * // Defer updating and reset the component's loading state
* interaction.deferUpdate() * interaction.deferUpdate()
@@ -203,7 +203,7 @@ class InteractionResponses {
/** /**
* Updates the original message of the component on which the interaction was received on. * Updates the original message of the component on which the interaction was received on.
* @param {string|MessagePayload|InteractionUpdateOptions} options The options for the updated message * @param {string|MessagePayload|InteractionUpdateOptions} options The options for the updated message
* @returns {Promise<Message|APIMessage|void>} * @returns {Promise<Message|void>}
* @example * @example
* // Remove the components from the message * // Remove the components from the message
* interaction.update({ * interaction.update({