Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix message action row components #8819

Merged
merged 3 commits into from Nov 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -66,10 +66,15 @@ class MessageComponentInteraction extends BaseInteraction {
}

/**
* Raw message components from the API
* * APIMessageButton
* * APIMessageSelectMenu
* @typedef {APIMessageButton|APIMessageSelectMenu} APIMessageActionRowComponent
* Components that can be placed in an action row for messages.
* * ButtonComponent
* * StringSelectMenuComponent
* * UserSelectMenuComponent
* * RoleSelectMenuComponent
* * MentionableSelectMenuComponent
* * ChannelSelectMenuComponent
* @typedef {ButtonComponent|StringSelectMenuComponent|UserSelectMenuComponent|
* RoleSelectMenuComponent|MentionableSelectMenuComponent|ChannelSelectMenuComponent} MessageActionRowComponent
*/

/**
Expand Down Expand Up @@ -100,13 +105,3 @@ class MessageComponentInteraction extends BaseInteraction {
InteractionResponses.applyToClass(MessageComponentInteraction);

module.exports = MessageComponentInteraction;

/**
* @external APIMessageSelectMenu
* @see {@link https://discord.com/developers/docs/interactions/message-components#select-menu-object}
*/

/**
* @external APIMessageButton
* @see {@link https://discord.com/developers/docs/interactions/message-components#button-object}
*/
5 changes: 5 additions & 0 deletions packages/discord.js/src/util/APITypes.js
Expand Up @@ -98,6 +98,11 @@
* @see {@link https://discord-api-types.dev/api/discord-api-types-v10/interface/APIMessage}
*/

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

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