diff --git a/src/client/Client.js b/src/client/Client.js index 48589813a..90fae09ff 100644 --- a/src/client/Client.js +++ b/src/client/Client.js @@ -92,26 +92,26 @@ class Client extends EventEmitter { /** * A collection of the Client's stored users - * @type {Collection} + * @type {Collection} */ this.users = new Collection(); /** * A collection of the Client's stored guilds - * @type {Collection} + * @type {Collection} */ this.guilds = new Collection(); /** * A collection of the Client's stored channels - * @type {Collection} + * @type {Collection} */ this.channels = new Collection(); /** * A collection of presences for friends of the logged in user. * This is only filled when using a user account. - * @type {Collection} + * @type {Collection} */ this.presences = new Collection(); @@ -191,7 +191,7 @@ class Client extends EventEmitter { /** * The emojis that the client can use. Mapped by emoji ID. - * @type {Collection} + * @type {Collection} * @readonly */ get emojis() { @@ -257,7 +257,7 @@ class Client extends EventEmitter { * This shouldn't really be necessary to most developers as it is automatically invoked every 30 seconds, however * if you wish to force a sync of guild data, you can use this. * This is only available when using a user account. - * @param {Guild[]|Collection} [guilds=this.guilds] An array or collection of guilds to sync + * @param {Guild[]|Collection} [guilds=this.guilds] An array or collection of guilds to sync */ syncGuilds(guilds = this.guilds) { if (this.user.bot) return; diff --git a/src/client/voice/ClientVoiceManager.js b/src/client/voice/ClientVoiceManager.js index 80725de01..1abe30eb4 100644 --- a/src/client/voice/ClientVoiceManager.js +++ b/src/client/voice/ClientVoiceManager.js @@ -18,13 +18,13 @@ class ClientVoiceManager { /** * A collection mapping connection IDs to the Connection objects - * @type {Collection} + * @type {Collection} */ this.connections = new Collection(); /** * Pending connection attempts, maps guild ID to VoiceChannel - * @type {Collection} + * @type {Collection} */ this.pending = new Collection(); diff --git a/src/client/websocket/packets/handlers/GuildMembersChunk.js b/src/client/websocket/packets/handlers/GuildMembersChunk.js index bee51571a..17994ae86 100644 --- a/src/client/websocket/packets/handlers/GuildMembersChunk.js +++ b/src/client/websocket/packets/handlers/GuildMembersChunk.js @@ -26,7 +26,7 @@ class GuildMembersChunkHandler extends AbstractHandler { /** * Emitted whenever a chunk of guild members is received (all members come from the same guild) * @event Client#guildMembersChunk - * @param {Collection} members The members in the chunk + * @param {Collection} members The members in the chunk * @param {Guild} guild The guild related to the member chunk */ diff --git a/src/client/websocket/packets/handlers/MessageDeleteBulk.js b/src/client/websocket/packets/handlers/MessageDeleteBulk.js index 6cd36484e..4c30cfc1b 100644 --- a/src/client/websocket/packets/handlers/MessageDeleteBulk.js +++ b/src/client/websocket/packets/handlers/MessageDeleteBulk.js @@ -11,7 +11,7 @@ class MessageDeleteBulkHandler extends AbstractHandler { /** * Emitted whenever messages are deleted in bulk * @event Client#messageDeleteBulk - * @param {Collection} messages The deleted messages, mapped by their ID + * @param {Collection} messages The deleted messages, mapped by their ID */ module.exports = MessageDeleteBulkHandler; diff --git a/src/structures/Guild.js b/src/structures/Guild.js index e8cc450b1..b42645452 100644 --- a/src/structures/Guild.js +++ b/src/structures/Guild.js @@ -301,7 +301,7 @@ class Guild { /** * Fetch a collection of banned users in this guild. - * @returns {Promise>} + * @returns {Promise>} */ fetchBans() { return this.client.rest.methods.getGuildBans(this); @@ -317,7 +317,7 @@ class Guild { /** * Fetch all webhooks for the guild. - * @returns {Collection} + * @returns {Collection} */ fetchWebhooks() { return this.client.rest.methods.getGuildWebhooks(this); diff --git a/src/structures/GuildMember.js b/src/structures/GuildMember.js index 79dd91fc7..fd6b6f325 100644 --- a/src/structures/GuildMember.js +++ b/src/structures/GuildMember.js @@ -322,7 +322,7 @@ class GuildMember { /** * Sets the roles applied to the member. - * @param {Collection|Role[]|string[]} roles The roles or role IDs to apply + * @param {Collection|Role[]|string[]} roles The roles or role IDs to apply * @returns {Promise} */ setRoles(roles) { @@ -341,7 +341,7 @@ class GuildMember { /** * Adds multiple roles to the member. - * @param {Collection|Role[]|string[]} roles The roles or role IDs to add + * @param {Collection|Role[]|string[]} roles The roles or role IDs to add * @returns {Promise} */ addRoles(roles) { @@ -367,7 +367,7 @@ class GuildMember { /** * Removes multiple roles from the member. - * @param {Collection|Role[]|string[]} roles The roles or role IDs to remove + * @param {Collection|Role[]|string[]} roles The roles or role IDs to remove * @returns {Promise} */ removeRoles(roles) { diff --git a/src/structures/MessageCollector.js b/src/structures/MessageCollector.js index 54e9b1539..9299cb162 100644 --- a/src/structures/MessageCollector.js +++ b/src/structures/MessageCollector.js @@ -137,7 +137,7 @@ class MessageCollector extends EventEmitter { this.channel.client.removeListener('message', this.listener); /** * Emitted when the Collector stops collecting. - * @param {Collection} collection A collection of messages collected + * @param {Collection} collection A collection of messages collected * during the lifetime of the collector, mapped by the ID of the messages. * @param {string} reason The reason for the end of the collector. If it ended because it reached the specified time * limit, this would be `time`. If you invoke `.stop()` without specifying a reason, this would be `user`. If it diff --git a/src/structures/UserProfile.js b/src/structures/UserProfile.js index 66a6c1616..cae791d04 100644 --- a/src/structures/UserProfile.js +++ b/src/structures/UserProfile.js @@ -22,13 +22,13 @@ class UserProfile { /** * Guilds that the client user and the user share - * @type {Collection} + * @type {Collection} */ this.mutualGuilds = new Collection(); /** * The user's connections - * @type {Collection} + * @type {Collection} */ this.connections = new Collection(); diff --git a/src/structures/interface/TextBasedChannel.js b/src/structures/interface/TextBasedChannel.js index 662ee1351..3d90b8995 100644 --- a/src/structures/interface/TextBasedChannel.js +++ b/src/structures/interface/TextBasedChannel.js @@ -188,7 +188,7 @@ class TextBasedChannel { /** * Gets the past messages sent in this channel. Resolves with a collection mapping message ID's to Message objects. * @param {ChannelLogsQueryOptions} [options={}] Query parameters to pass in - * @returns {Promise>} + * @returns {Promise>} * @example * // get messages * channel.fetchMessages({limit: 10}) @@ -209,7 +209,7 @@ class TextBasedChannel { /** * Fetches the pinned messages of this channel and returns a collection of them. - * @returns {Promise>} + * @returns {Promise>} */ fetchPinnedMessages() { return this.client.rest.methods.getChannelPinnedMessages(this).then(data => { @@ -336,7 +336,7 @@ class TextBasedChannel { * filter. * @param {CollectorFilterFunction} filter The filter function to use * @param {AwaitMessagesOptions} [options={}] Optional options to pass to the internal collector - * @returns {Promise>} + * @returns {Promise>} * @example * // await !vote messages * const filter = m => m.content.startsWith('!vote'); @@ -361,9 +361,9 @@ class TextBasedChannel { /** * Bulk delete given messages that are newer than two weeks * This is only available when using a bot account. - * @param {Collection|Message[]|number} messages Messages to delete, or number of messages to delete + * @param {Collection|Message[]|number} messages Messages or number of messages to delete * @param {boolean} [filterOld=false] Filter messages to remove those which are older than two weeks automatically - * @returns {Promise>} Deleted messages + * @returns {Promise>} Deleted messages */ bulkDelete(messages, filterOld = false) { if (!isNaN(messages)) return this.fetchMessages({ limit: messages }).then(msgs => this.bulkDelete(msgs));