From 300059cb266e6cca42c30ee7f997c48ab2cc565e Mon Sep 17 00:00:00 2001 From: BoogeyMan <76151726+BoogeyMan24@users.noreply.github.com> Date: Fri, 14 Apr 2023 23:46:15 +0200 Subject: [PATCH] docs: cleanup MessageCreateOptions and MessageReplyOptions (#9283) * Fixed MessageReplyOptions * updated MessageReplyOptions * Deduplication - created BaseMessageCreateOptions * Update packages/discord.js/src/structures/interfaces/TextBasedChannel.js Co-authored-by: Jaw0r3k * Fixed spacing --------- Co-authored-by: Jaw0r3k Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> --- packages/discord.js/src/structures/Message.js | 1 - .../src/structures/interfaces/TextBasedChannel.js | 9 +++++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/packages/discord.js/src/structures/Message.js b/packages/discord.js/src/structures/Message.js index ea0d6f724d2a..c82c177ab146 100644 --- a/packages/discord.js/src/structures/Message.js +++ b/packages/discord.js/src/structures/Message.js @@ -822,7 +822,6 @@ class Message extends Base { * @typedef {BaseMessageCreateOptions} MessageReplyOptions * @property {boolean} [failIfNotExists=this.client.options.failIfNotExists] Whether to error if the referenced * message does not exist (creates a standard message in this case when false) - * @property {StickerResolvable[]} [stickers=[]] Stickers to send in the message */ /** diff --git a/packages/discord.js/src/structures/interfaces/TextBasedChannel.js b/packages/discord.js/src/structures/interfaces/TextBasedChannel.js index d5f9b27f2472..d9e1cb24f5d4 100644 --- a/packages/discord.js/src/structures/interfaces/TextBasedChannel.js +++ b/packages/discord.js/src/structures/interfaces/TextBasedChannel.js @@ -75,15 +75,20 @@ class TextBasedChannel { /** * The options for sending a message. - * @typedef {BaseMessageOptions} MessageCreateOptions + * @typedef {BaseMessageOptions} BaseMessageCreateOptions * @property {boolean} [tts=false] Whether the message should be spoken aloud * @property {string} [nonce=''] The nonce for the message - * @property {ReplyOptions} [reply] The options for replying to a message * @property {StickerResolvable[]} [stickers=[]] The stickers to send in the message * @property {MessageFlags} [flags] Which flags to set for the message. * Only `MessageFlags.SuppressEmbeds` and `MessageFlags.SuppressNotifications` can be set. */ + /** + * The options for sending a message. + * @typedef {BaseMessageCreateOptions} MessageCreateOptions + * @property {ReplyOptions} [reply] The options for replying to a message + */ + /** * Options provided to control parsing of mentions by Discord * @typedef {Object} MessageMentionOptions