From 77cb8d9fe7c68c564d8e49a5d3479192c9135aaa Mon Sep 17 00:00:00 2001 From: Starman <30315137+Starman3787@users.noreply.github.com> Date: Sun, 22 Dec 2024 21:08:15 +0000 Subject: [PATCH] update jsdoc comments for typings --- src/managers/BaseCacheManager.js | 2 +- src/managers/ChannelCacheOptions.js | 2 +- src/managers/GuildCacheOptions.js | 2 +- src/managers/MessagePollManager.js | 2 +- src/managers/MessageReactionManager.js | 2 +- src/structures/Attachment.js | 2 +- src/structures/AuditLog.js | 2 +- src/structures/ButtonClick.js | 2 +- src/structures/CategoryChannel.js | 2 +- src/structures/Channel.js | 14 ++-- src/structures/Emoji.js | 4 +- src/structures/Guild.js | 34 +++++++--- src/structures/Interaction.js | 39 +++++++----- src/structures/Invite.js | 2 +- src/structures/Member.js | 31 ++++----- src/structures/Message.js | 88 +++++++++++++------------- src/structures/ModalResponse.js | 2 +- src/structures/OptionSelect.js | 2 +- src/structures/PermissionOverwrite.js | 2 +- src/structures/Poll.js | 2 +- src/structures/Reaction.js | 2 +- src/structures/Role.js | 4 +- src/structures/ScheduledEvent.js | 4 +- src/structures/SlashCommand.js | 2 +- src/structures/Sticker.js | 2 +- src/structures/TextChannel.js | 4 +- src/structures/Thread.js | 2 +- src/structures/User.js | 4 +- src/structures/VoiceChannel.js | 2 +- src/structures/VoiceState.js | 2 +- 30 files changed, 145 insertions(+), 121 deletions(-) diff --git a/src/managers/BaseCacheManager.js b/src/managers/BaseCacheManager.js index 15b03972..f676004b 100644 --- a/src/managers/BaseCacheManager.js +++ b/src/managers/BaseCacheManager.js @@ -323,7 +323,7 @@ class BaseCacheManager { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/managers/ChannelCacheOptions.js b/src/managers/ChannelCacheOptions.js index 7b46a3d3..c29c37ad 100644 --- a/src/managers/ChannelCacheOptions.js +++ b/src/managers/ChannelCacheOptions.js @@ -363,7 +363,7 @@ class ChannelCacheOptions { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/managers/GuildCacheOptions.js b/src/managers/GuildCacheOptions.js index f74eee39..0673659b 100644 --- a/src/managers/GuildCacheOptions.js +++ b/src/managers/GuildCacheOptions.js @@ -343,7 +343,7 @@ class GuildCacheOptions { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/managers/MessagePollManager.js b/src/managers/MessagePollManager.js index 8070b521..58f173ab 100644 --- a/src/managers/MessagePollManager.js +++ b/src/managers/MessagePollManager.js @@ -97,7 +97,7 @@ class MessagePollManager { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/managers/MessageReactionManager.js b/src/managers/MessageReactionManager.js index 03f882b3..e6f1d7a2 100644 --- a/src/managers/MessageReactionManager.js +++ b/src/managers/MessageReactionManager.js @@ -102,7 +102,7 @@ class MessageReactionManager { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Attachment.js b/src/structures/Attachment.js index d3a9bf6e..d26cf939 100644 --- a/src/structures/Attachment.js +++ b/src/structures/Attachment.js @@ -167,7 +167,7 @@ class Attachment { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/AuditLog.js b/src/structures/AuditLog.js index aa933269..4b3f17ce 100644 --- a/src/structures/AuditLog.js +++ b/src/structures/AuditLog.js @@ -384,7 +384,7 @@ class AuditLog { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/ButtonClick.js b/src/structures/ButtonClick.js index d3f04db2..17a2cee7 100644 --- a/src/structures/ButtonClick.js +++ b/src/structures/ButtonClick.js @@ -97,7 +97,7 @@ class ButtonClick extends Interaction { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/CategoryChannel.js b/src/structures/CategoryChannel.js index 36c685d0..a10fa58c 100644 --- a/src/structures/CategoryChannel.js +++ b/src/structures/CategoryChannel.js @@ -219,7 +219,7 @@ class CategoryChannel { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Channel.js b/src/structures/Channel.js index b50d669d..f1a0d395 100644 --- a/src/structures/Channel.js +++ b/src/structures/Channel.js @@ -180,12 +180,12 @@ class Channel { /** * Sends a message to this channel. - * @param {Object} data Embeds, components and files to include with the message. - * @param {String?} data.content The content of the message. - * @param {Array?} data.embeds The embeds to include with the message. - * @param {Array?} data.components The components to include with the message. - * @param {Array?} data.files The files to include with the message. - * @param {Boolean} data.suppressMentions Whether to suppress mentions in the message. + * @param {Object} [data] Embeds, components and files to include with the message. + * @param {String?} [data.content] The content of the message. + * @param {Array?} [data.embeds] The embeds to include with the message. + * @param {Array?} [data.components] The components to include with the message. + * @param {Array?} [data.files] The files to include with the message. + * @param {Boolean} [data.suppressMentions] Whether to suppress mentions in the message. * @returns {Promise} * @see {@link https://discord.com/developers/docs/resources/channel#create-message} * @method @@ -496,7 +496,7 @@ class Channel { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Emoji.js b/src/structures/Emoji.js index be176c04..83dfe8bd 100644 --- a/src/structures/Emoji.js +++ b/src/structures/Emoji.js @@ -237,7 +237,7 @@ class Emoji { /** * Returns the url for an emoji. * @param {String} id The id of the emoji. - * @param {Boolean} animated Whether the emoji is animated. + * @param {Boolean} [animated] Whether the emoji is animated. * @returns {String} * @public * @static @@ -292,7 +292,7 @@ class Emoji { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Guild.js b/src/structures/Guild.js index ed120a51..852d42d1 100644 --- a/src/structures/Guild.js +++ b/src/structures/Guild.js @@ -28,6 +28,7 @@ import GluonCacheOptions from "../managers/GluonCacheOptions.js"; import util from "util"; import Client from "../Client.js"; import Message from "./Message.js"; +import { Embed } from "../util.js"; /** * Represents a Discord guild. @@ -1078,7 +1079,9 @@ class Guild { /** * Bans a user with the given id from the guild. * @param {String} user_id The id of the user to ban. - * @param {Object?} options Ban options. + * @param {Object?} [options] Ban options. + * @param {String?} [options.reason] The reason for banning the user. + * @param {Number?} [options.seconds] The number of seconds to delete messages for. * @returns {Promise} * @async * @public @@ -1122,7 +1125,8 @@ class Guild { /** * Unbans a user with the given id from the guild. * @param {String} user_id The id of the user to unban. - * @param {Object?} options Unban options. + * @param {Object?} [options] Unban options. + * @param {String?} [options.reason] The reason for unbanning the user. * @returns {Promise} * @async * @public @@ -1158,7 +1162,8 @@ class Guild { /** * Kicks a user with the given id from the guild. * @param {String} user_id The id of the user to kick. - * @param {Object?} options Kick options. + * @param {Object?} [options] Kick options. + * @param {String?} [options.reason] The reason for kicking the user. * @returns {Promise} * @async * @public @@ -1195,7 +1200,8 @@ class Guild { * Removes the given role from the given member. * @param {String} user_id The id of the user. * @param {String} role_id The id of the role. - * @param {Object?} options Remove role options. + * @param {Object?} [options] Remove role options. + * @param {String?} [options.reason] The reason for removing the role. * @returns {Promise} * @async * @public @@ -1233,7 +1239,12 @@ class Guild { /** * Fetches audit logs. - * @param {Object?} options Audit log fetch options. + * @param {Object?} [options] Audit log fetch options. + * @param {Number?} [options.limit] The number of entries to fetch. + * @param {Number?} [options.type] The type of audit log to fetch. + * @param {String?} [options.user_id] The id of the user to fetch the audit log for. + * @param {String?} [options.before] The id of the audit log entry to fetch before. + * @param {String?} [options.after] The id of the audit log entry to fetch after * @returns {Promise} * @async * @public @@ -1433,8 +1444,8 @@ class Guild { * Creates a webhook in the given channel with the name "Gluon". * @param {Client} client The client instance. * @param {String} channelId The id of the channel to create the webhook in. - * @param {Object} options The options for creating the webhook. - * @param {String} options.name The name of the webhook. + * @param {Object} [options] The options for creating the webhook. + * @param {String} [options.name] The name of the webhook. * @returns {Promise} * @public * @method @@ -1508,8 +1519,13 @@ class Guild { * Posts a webhook with the provided webhook id and token. * @param {Client} client The client instance. * @param {Object} referenceData An object with the webhook id and token. + * @param {String} referenceData.id The id of the webhook. + * @param {String} referenceData.token The token of the webhook. * @param {String?} content The message to send with the webhook. - * @param {Object?} options Embeds, components and files to attach to the webhook. + * @param {Object?} [options] Embeds, components and files to attach to the webhook. + * @param {Embed[]} [options.embeds] The embeds to attach to the webhook. + * @param {MessageComponent[]} [options.components] The components to attach to the webhook. + * @param {File[]} [options.files] The files to attach to the webhook. * @returns {Promise} * @public * @method @@ -1613,7 +1629,7 @@ class Guild { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Interaction.js b/src/structures/Interaction.js index ee5a4274..58e46972 100644 --- a/src/structures/Interaction.js +++ b/src/structures/Interaction.js @@ -5,6 +5,7 @@ import { TO_JSON_TYPES_ENUM } from "../constants.js"; import util from "util"; import Message from "./Message.js"; import Client from "../Client.js"; +import { CommandChoice } from "../util.js"; /** * Represents an interaction received over the gateway. @@ -167,6 +168,9 @@ class Interaction { /** * Prompts a user to enter text using a modal. * @param {Object} options Modal options. + * @param {String} options.title The title of the modal. + * @param {String} options.customId The custom id of the modal. + * @param {TextInput} options.textInputModal The text input modal. * @returns {Promise} * @public * @async @@ -207,6 +211,7 @@ class Interaction { /** * Responds to autocomplete interactions. * @param {Object} options Autocompletion options. + * @param {Array} options.choices The choices to send back. * @returns {Promise} * @public * @async @@ -233,12 +238,12 @@ class Interaction { /** * Replies to an interaction. - * @param {Object?} options An embed, components, and whether the response should be as an ephemeral message. - * @param {String?} options.content The content of the interaction response. - * @param {Array?} options.files The files to send with the interaction response. - * @param {Array?} options.embeds The embeds to send with the interaction response. - * @param {Array?} options.components The components to send with the interaction response. - * @param {Boolean?} options.quiet Whether the response should be an ephemeral message. + * @param {Object?} [options] An embed, components, and whether the response should be as an ephemeral message. + * @param {String?} [options.content] The content of the interaction response. + * @param {Array?} [options.files] The files to send with the interaction response. + * @param {Array?} [options.embeds] The embeds to send with the interaction response. + * @param {Array?} [options.components] The components to send with the interaction response. + * @param {Boolean?} [options.quiet] Whether the response should be an ephemeral message. * @returns {Promise} * @public * @async @@ -300,11 +305,11 @@ class Interaction { /** * Edits a response to an interaction. Works up to 15 minutes after the response was sent. - * @param {Object?} options The new interaction response options. - * @param {String?} options.content The new content of the interaction response. - * @param {Array?} options.files The new files to send with the interaction response. - * @param {Array?} options.embeds The new embeds to send with the interaction response. - * @param {Array?} options.components The new components to send with the interaction response. + * @param {Object?} [options] The new interaction response options. + * @param {String?} [options.content] The new content of the interaction response. + * @param {Array?} [options.files] The new files to send with the interaction response. + * @param {Array?} [options.embeds] The new embeds to send with the interaction response. + * @param {Array?} [options.components] The new components to send with the interaction response. * @returns {Promise} * @public * @async @@ -324,11 +329,11 @@ class Interaction { * Edits a response to an interaction. Works up to 15 minutes after the response was sent. * @param {Client} client The client instance. * @param {String} interactionToken The interaction token. - * @param {Object?} options The new interaction response options. - * @param {String?} options.content The new content of the interaction response. - * @param {Array?} options.files The new files to send with the interaction response. - * @param {Array?} options.embeds The new embeds to send with the interaction response. - * @param {Array?} options.components The new components to send with the interaction response. + * @param {Object?} [options] The new interaction response options. + * @param {String?} [options.content] The new content of the interaction response. + * @param {Array?} [options.files] The new files to send with the interaction response. + * @param {Array?} [options.embeds] The new embeds to send with the interaction response. + * @param {Array?} [options.components] The new components to send with the interaction response. * @returns {Promise} * @public * @async @@ -380,7 +385,7 @@ class Interaction { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Invite.js b/src/structures/Invite.js index 185d6646..d2ad7b58 100644 --- a/src/structures/Invite.js +++ b/src/structures/Invite.js @@ -296,7 +296,7 @@ class Invite { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Member.js b/src/structures/Member.js index ceeaadf2..71958578 100644 --- a/src/structures/Member.js +++ b/src/structures/Member.js @@ -463,7 +463,7 @@ class Member { * Returns the avatar url for the member. * @param {String} id The id of the user. * @param {String} guild_id The id of the guild the user belongs to. - * @param {String?} hash The avatar hash of the user. + * @param {String?} [hash] The avatar hash of the user. * @returns {String} * @public * @static @@ -486,8 +486,8 @@ class Member { /** * Adds a role to the member. * @param {String} role_id The id of the role to add to the member. - * @param {Object?} options The options for adding the role to the member. - * @param {String?} options.reason The reason for adding the role to the member. + * @param {Object?} [options] The options for adding the role to the member. + * @param {String?} [options.reason] The reason for adding the role to the member. * @returns {Promise} * @public * @async @@ -503,8 +503,8 @@ class Member { /** * Removes a role from the member. * @param {String} role_id The id of the role to remove from the member. - * @param {Object?} options The options for removing the role from the member. - * @param {String?} options.reason The reason for removing the role from the member. + * @param {Object?} [options] The options for removing the role from the member. + * @param {String?} [options.reason] The reason for removing the role from the member. * @returns {Promise} * @public * @async @@ -520,8 +520,8 @@ class Member { /** * Adds a timeout to the member. * @param {Number} timeout_until The UNIX timestamp for when the member's timeout should end. - * @param {Object?} options The options for timing out the member. - * @param {String?} options.reason The reason for timing out the member. + * @param {Object?} [options] The options for timing out the member. + * @param {String?} [options.reason] The reason for timing out the member. * @returns {Promise} * @public * @async @@ -560,8 +560,8 @@ class Member { /** * Removes a timeout from the member. - * @param {Object?} options The options for untiming out the member. - * @param {String?} options.reason The reason for removing the time out from the member. + * @param {Object?} [options] The options for untiming out the member. + * @param {String?} [options.reason] The reason for removing the time out from the member. * @returns {Promise} * @public * @async @@ -596,7 +596,8 @@ class Member { /** * Updates the member's roles. * @param {Array} roles An array of role ids for the roles the member should be updated with. - * @param {Object?} options The options for updating the member's roles. + * @param {Object?} [options] The options for updating the member's roles. + * @param {String?} [options.reason] The reason for updating the member's roles. * @returns {Promise} * @public * @async @@ -700,8 +701,8 @@ class Member { * @param {String} guildId The guild id the member belongs to. * @param {String} userId The id of the member who the action is occuring on. * @param {String} roleId The id of the role to add. - * @param {Object} options The options for adding the role. - * @param {String} options.reason The reason for adding the role. + * @param {Object} [options] The options for adding the role. + * @param {String?} [options.reason] The reason for adding the role. * @returns {Promise} * @public * @method @@ -743,8 +744,8 @@ class Member { * @param {String} guildId The guild id the member belongs to. * @param {String} userId The id of the member who the action is occuring on. * @param {String} roleId The id of the role to remove. - * @param {Object} options The options for removing the role. - * @param {String} options.reason The reason for removing the role. + * @param {Object} [options] The options for removing the role. + * @param {String?} [options.reason] The reason for removing the role. * @returns {Promise} * @public * @method @@ -808,7 +809,7 @@ class Member { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Message.js b/src/structures/Message.js index 268a6e4d..1e30bcbd 100644 --- a/src/structures/Message.js +++ b/src/structures/Message.js @@ -778,11 +778,11 @@ class Message { /** * Replies to the message. - * @param {Object?} options Embeds, components and files to attach to the message. - * @param {String?} options.content The message content. - * @param {Embed?} options.embed Embed to send with the message. - * @param {MessageComponents?} options.components Message components to send with the message. - * @param {Array?} options.files Array of file objects for files to send with the message. + * @param {Object?} [options] Embeds, components and files to attach to the message. + * @param {String?} [options.content] The message content. + * @param {Embed?} [options.embed] Embed to send with the message. + * @param {MessageComponents?} [options.components] Message components to send with the message. + * @param {Array?} [options.files] Array of file objects for files to send with the message. * @returns {Promise} * @see {@link https://discord.com/developers/docs/resources/channel#create-message} * @method @@ -807,17 +807,17 @@ class Message { /** * Edits the message, assuming it is sent by the client user. - * @param {Object?} options Content, embeds and components to attach to the message. - * @param {String?} options.content The message content. - * @param {Embed?} options.embed Embed to send with the message. - * @param {MessageComponents?} options.components Message components to send with the message. - * @param {Array?} options.attachments Array of attachment objects for files to send with the message. - * @param {Number?} options.flags The message flags. - * @param {Object?} options.reference The message reference. - * @param {String?} options.reference.message_id The id of the message to reference. - * @param {String?} options.reference.channel_id The id of the channel to reference. - * @param {String?} options.reference.guild_id The id of the guild to reference. - * @param {FileUpload[]?} options.files Array of file objects for files to send with the message. + * @param {Object?} [options] Content, embeds and components to attach to the message. + * @param {String?} [options.content] The message content. + * @param {Embed?} [options.embed] Embed to send with the message. + * @param {MessageComponents?} [options.components] Message components to send with the message. + * @param {Array?} [options.attachments] Array of attachment objects for files to send with the message. + * @param {Number?} [options.flags] The message flags. + * @param {Object?} [options.reference] The message reference. + * @param {String?} [options.reference.message_id] The id of the message to reference. + * @param {String?} [options.reference.channel_id] The id of the channel to reference. + * @param {String?} [options.reference.guild_id] The id of the guild to reference. + * @param {FileUpload[]?} [options.files] Array of file objects for files to send with the message. * @returns {Promise} * @see {@link https://discord.com/developers/docs/resources/channel#edit-message} * @method @@ -861,8 +861,8 @@ class Message { /** * Deletes the message. - * @param {Object?} options The options for deleting the message. - * @param {String?} options.reason The reason for deleting the message + * @param {Object?} [options] The options for deleting the message. + * @param {String?} [options.reason] The reason for deleting the message * @returns {Promise} * @method * @public @@ -916,12 +916,12 @@ class Message { * @param {Client} client The client instance. * @param {String} channelId The id of the channel to send the message to. * @param {String} guildId The id of the guild which the channel belongs to. - * @param {Object?} options Content, embeds, components and files to attach to the message. - * @param {String?} options.content The message content. - * @param {Embed[]} options.embeds Array of embeds to send with the message. - * @param {MessageComponents?} options.components Message components to send with the message. - * @param {Array?} options.files Array of file objects for files to send with the message. - * @param {Boolean?} options.suppressMentions Whether to suppress mentions in the message. + * @param {Object?} [options] Content, embeds, components and files to attach to the message. + * @param {String?} [options.content] The message content. + * @param {Embed[]} [options.embeds] Array of embeds to send with the message. + * @param {MessageComponents?} [options.components] Message components to send with the message. + * @param {Array?} [options.files] Array of file objects for files to send with the message. + * @param {Boolean?} [options.suppressMentions] Whether to suppress mentions in the message. * @returns {Promise} * @public * @method @@ -998,12 +998,12 @@ class Message { * @param {String} channelId The id of the channel the message belongs to. * @param {String} messageId The id of the message. * @param {String} guildId The id of the guild the message belongs to. - * @param {Object?} options The message options. - * @param {String?} options.content The message content. - * @param {Embed[]?} options.embeds Array of embeds to send with the message. - * @param {MessageComponents?} options.components Message components to send with the message. - * @param {Array?} options.files Array of file objects for files to send with the message. - * @param {Array?} options.attachments Array of attachment objects for existing attachments sent with the message. + * @param {Object?} [options] The message options. + * @param {String?} [options.content] The message content. + * @param {Embed[]?} [options.embeds] Array of embeds to send with the message. + * @param {MessageComponents?} [options.components] Message components to send with the message. + * @param {Array?} [options.files] Array of file objects for files to send with the message. + * @param {Array?} [options.attachments] Array of attachment objects for existing attachments sent with the message. * @returns {Promise} */ static async edit( @@ -1110,17 +1110,17 @@ class Message { /** * Validates the message content, embeds, components and files. - * @param {Object} options The message options. - * @param {String} options.content The message content. - * @param {Embed[]} options.embeds Array of embeds to send with the message. - * @param {MessageComponents} options.components Message components to send with the message. - * @param {Array} options.files Array of file objects for files to send with the message. - * @param {Array} options.attachments Array of attachment objects for existing attachments sent with the message. - * @param {Number} options.flags The message flags. - * @param {Object} options.reference The message reference. - * @param {String} options.reference.message_id The id of the message to reference. - * @param {String} options.reference.channel_id The id of the channel to reference. - * @param {String} options.reference.guild_id The id of the guild to reference. + * @param {Object} [options] The message options. + * @param {String} [options.content] The message content. + * @param {Embed[]} [options.embeds] Array of embeds to send with the message. + * @param {MessageComponents} [options.components] Message components to send with the message. + * @param {Array} [options.files] Array of file objects for files to send with the message. + * @param {Array} [options.attachments] Array of attachment objects for existing attachments sent with the message. + * @param {Number} [options.flags] The message flags. + * @param {Object} [options.reference] The message reference. + * @param {String} [options.reference.message_id] The id of the message to reference. + * @param {String} [options.reference.channel_id] The id of the channel to reference. + * @param {String} [options.reference.guild_id] The id of the guild to reference. * @returns {void} * @throws {Error | TypeError | RangeError} * @public @@ -1207,8 +1207,8 @@ class Message { * @param {Client} client The client instance. * @param {String} channelId The id of the channel that the message belongs to. * @param {String} messageId The id of the message to delete. - * @param {Object?} options - * @param {String?} options.reason The reason for deleting the message. + * @param {Object?} [options] + * @param {String?} [options.reason] The reason for deleting the message. * @returns {Promise} * @public * @method @@ -1278,7 +1278,7 @@ class Message { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/ModalResponse.js b/src/structures/ModalResponse.js index 67191608..8180affc 100644 --- a/src/structures/ModalResponse.js +++ b/src/structures/ModalResponse.js @@ -77,7 +77,7 @@ class ModalResponse extends Interaction { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/OptionSelect.js b/src/structures/OptionSelect.js index 81866e7d..d2c13612 100644 --- a/src/structures/OptionSelect.js +++ b/src/structures/OptionSelect.js @@ -116,7 +116,7 @@ class OptionSelect extends Interaction { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/PermissionOverwrite.js b/src/structures/PermissionOverwrite.js index 88ef8e4d..722730ca 100644 --- a/src/structures/PermissionOverwrite.js +++ b/src/structures/PermissionOverwrite.js @@ -109,7 +109,7 @@ class PermissionOverwrite { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Poll.js b/src/structures/Poll.js index 809d0d8e..337df5de 100644 --- a/src/structures/Poll.js +++ b/src/structures/Poll.js @@ -201,7 +201,7 @@ class Poll { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Reaction.js b/src/structures/Reaction.js index ef3252f1..46312e84 100644 --- a/src/structures/Reaction.js +++ b/src/structures/Reaction.js @@ -198,7 +198,7 @@ class Reaction { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Role.js b/src/structures/Role.js index 5c2715ed..e4a4d60a 100644 --- a/src/structures/Role.js +++ b/src/structures/Role.js @@ -312,7 +312,7 @@ class Role { /** * Returns the URL of the role's icon. * @param {String} id The ID of the role. - * @param {String?} hash The hash of the role's icon. + * @param {String?} [hash] The hash of the role's icon. * @returns {String} */ static getIconUrl(id, hash) { @@ -368,7 +368,7 @@ class Role { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/ScheduledEvent.js b/src/structures/ScheduledEvent.js index 51674b55..7689dcee 100644 --- a/src/structures/ScheduledEvent.js +++ b/src/structures/ScheduledEvent.js @@ -395,7 +395,7 @@ class ScheduledEvent { /** * Returns the URL of the event's image. * @param {String} id The id of the event. - * @param {String?} hash The hash of the event's image. + * @param {String?} [hash] The hash of the event's image. * @returns {String} * @public * @static @@ -454,7 +454,7 @@ class ScheduledEvent { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/SlashCommand.js b/src/structures/SlashCommand.js index 94253387..56685a1f 100644 --- a/src/structures/SlashCommand.js +++ b/src/structures/SlashCommand.js @@ -98,7 +98,7 @@ class SlashCommand extends Interaction { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Sticker.js b/src/structures/Sticker.js index 08375ec4..7ba89a07 100644 --- a/src/structures/Sticker.js +++ b/src/structures/Sticker.js @@ -137,7 +137,7 @@ class Sticker { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/TextChannel.js b/src/structures/TextChannel.js index a499f498..6210e839 100644 --- a/src/structures/TextChannel.js +++ b/src/structures/TextChannel.js @@ -73,6 +73,8 @@ class TextChannel extends Channel { /** * Bulk deletes all the message IDs provided. * @param {String[]} messages An array of message IDs, as strings. + * @param {Object?} [options] Additional options for this method. + * @param {String?} [options.reason] The reason for this action. * @returns {Promise} * @method * @async @@ -128,7 +130,7 @@ class TextChannel extends Channel { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/Thread.js b/src/structures/Thread.js index 4a9986c5..b684de77 100644 --- a/src/structures/Thread.js +++ b/src/structures/Thread.js @@ -157,7 +157,7 @@ class Thread extends Channel { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/User.js b/src/structures/User.js index dda0ab73..042edbd8 100644 --- a/src/structures/User.js +++ b/src/structures/User.js @@ -313,7 +313,7 @@ class User { /** * Returns the URL to the user's avatar. * @param {String} id The ID of the user to get the avatar for. - * @param {String?} hash The hash of the avatar. + * @param {String?} [hash] The hash of the avatar. * @returns {String} * @public * @static @@ -368,7 +368,7 @@ class User { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/VoiceChannel.js b/src/structures/VoiceChannel.js index 866d2428..29dc53ae 100644 --- a/src/structures/VoiceChannel.js +++ b/src/structures/VoiceChannel.js @@ -146,7 +146,7 @@ class VoiceChannel extends Channel { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method diff --git a/src/structures/VoiceState.js b/src/structures/VoiceState.js index a7e6e673..57a8ce88 100644 --- a/src/structures/VoiceState.js +++ b/src/structures/VoiceState.js @@ -337,7 +337,7 @@ class VoiceState { /** * Returns the JSON representation of this structure. - * @param {Number} format The format to return the data in. + * @param {Number} [format] The format to return the data in. * @returns {Object} * @public * @method