Skip to content

Commit

Permalink
docs: cleanup MessageCreateOptions and MessageReplyOptions (#9283)
Browse files Browse the repository at this point in the history
* Fixed MessageReplyOptions

* updated MessageReplyOptions

* Deduplication - created BaseMessageCreateOptions

* Update packages/discord.js/src/structures/interfaces/TextBasedChannel.js

Co-authored-by: Jaw0r3k <jaworekwiadomosci@gmail.com>

* Fixed spacing

---------

Co-authored-by: Jaw0r3k <jaworekwiadomosci@gmail.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
  • Loading branch information
3 people committed Apr 14, 2023
1 parent d4c1fec commit 300059c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
1 change: 0 additions & 1 deletion packages/discord.js/src/structures/Message.js
Expand Up @@ -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
*/

/**
Expand Down
Expand Up @@ -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.
* <info>Only `MessageFlags.SuppressEmbeds` and `MessageFlags.SuppressNotifications` can be set.</info>
*/

/**
* 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
Expand Down

0 comments on commit 300059c

Please sign in to comment.