From c7d1507e19ceccc2629c6d83c0bbf4a03c174b09 Mon Sep 17 00:00:00 2001 From: Crawl Date: Sun, 20 Aug 2017 22:08:37 +0200 Subject: [PATCH] Docs cleanup --- docs/examples/greeting.js | 6 +- src/client/ClientDataResolver.js | 6 +- src/client/voice/VoiceBroadcast.js | 24 +-- src/client/voice/VoiceConnection.js | 26 +-- .../voice/dispatcher/StreamDispatcher.js | 10 +- src/client/voice/opus/BaseOpusEngine.js | 8 +- src/client/voice/player/AudioPlayer.js | 2 +- src/client/voice/receiver/VoiceReceiver.js | 7 +- src/client/websocket/WebSocketConnection.js | 8 +- src/client/websocket/WebSocketManager.js | 6 +- src/sharding/Shard.js | 8 +- src/sharding/ShardClientUtil.js | 8 +- src/sharding/ShardingManager.js | 8 +- src/structures/Channel.js | 4 +- src/structures/ClientUser.js | 24 +-- src/structures/Emoji.js | 6 +- src/structures/Guild.js | 56 +++--- src/structures/GuildAuditLogs.js | 2 +- src/structures/GuildChannel.js | 22 +- src/structures/GuildMember.js | 2 +- src/structures/Message.js | 28 +-- src/structures/MessageCollector.js | 5 +- src/structures/ReactionCollector.js | 2 +- src/structures/Role.js | 34 ++-- src/structures/TextChannel.js | 6 +- src/structures/UserProfile.js | 2 +- src/structures/VoiceChannel.js | 12 +- src/structures/Webhook.js | 4 +- src/structures/interfaces/TextBasedChannel.js | 16 +- src/util/Constants.js | 190 ++++++++++-------- src/util/Permissions.js | 6 +- src/util/Util.js | 6 +- 32 files changed, 287 insertions(+), 267 deletions(-) diff --git a/docs/examples/greeting.js b/docs/examples/greeting.js index e9c92e076..55bf2d00d 100644 --- a/docs/examples/greeting.js +++ b/docs/examples/greeting.js @@ -19,11 +19,7 @@ client.on('ready', () => { // Create an event listener for new guild members client.on('guildMemberAdd', member => { - // Send the message to the guilds default channel (usually #general), mentioning the member - member.guild.defaultChannel.send(`Welcome to the server, ${member}!`); - - // If you want to send the message to a designated channel on a server instead - // you can do the following: + // Send the message to a designated channel on a server: const channel = member.guild.channels.find('name', 'member-log'); // Do nothing if the channel wasn't found on this server if (!channel) return; diff --git a/src/client/ClientDataResolver.js b/src/client/ClientDataResolver.js index a7f3e2508..adf28467a 100644 --- a/src/client/ClientDataResolver.js +++ b/src/client/ClientDataResolver.js @@ -28,7 +28,7 @@ class ClientDataResolver { /** * Data that resolves to give a User object. This can be: * * A User object - * * A user ID + * * A Snowflake * * A Message object (resolves to the message author) * * A Guild object (owner of the guild) * * A GuildMember object @@ -65,7 +65,7 @@ class ClientDataResolver { /** * Data that resolves to give a Guild object. This can be: * * A Guild object - * * A Guild ID + * * A Snowflake * @typedef {Guild|Snowflake} GuildResolvable */ @@ -106,7 +106,7 @@ class ClientDataResolver { * * A Channel object * * A Message object (the channel the message was sent in) * * A Guild object (the #general channel) - * * A channel ID + * * A Snowflake * @typedef {Channel|Guild|Message|Snowflake} ChannelResolvable */ diff --git a/src/client/voice/VoiceBroadcast.js b/src/client/voice/VoiceBroadcast.js index 76513d86a..3a78d87a7 100644 --- a/src/client/voice/VoiceBroadcast.js +++ b/src/client/voice/VoiceBroadcast.js @@ -18,7 +18,7 @@ const ffmpegArguments = [ * ```js * const broadcast = client.createVoiceBroadcast(); * broadcast.playFile('./music.mp3'); - * // play "music.mp3" in all voice connections that the client is in + * // Play "music.mp3" in all voice connections that the client is in * for (const connection of client.voiceConnections.values()) { * connection.playBroadcast(broadcast); * } @@ -136,12 +136,12 @@ class VoiceBroadcast extends VolumeInterface { * const broadcast = client.createVoiceBroadcast(); * * voiceChannel.join() - * .then(connection => { - * const stream = ytdl('https://www.youtube.com/watch?v=XAWgeLF9EVQ', { filter : 'audioonly' }); - * broadcast.playStream(stream); - * const dispatcher = connection.playBroadcast(broadcast); - * }) - * .catch(console.error); + * .then(connection => { + * const stream = ytdl('https://www.youtube.com/watch?v=XAWgeLF9EVQ', { filter : 'audioonly' }); + * broadcast.playStream(stream); + * const dispatcher = connection.playBroadcast(broadcast); + * }) + * .catch(console.error); */ playStream(stream, options = {}) { this.setVolume(options.volume || 1); @@ -158,11 +158,11 @@ class VoiceBroadcast extends VolumeInterface { * const broadcast = client.createVoiceBroadcast(); * * voiceChannel.join() - * .then(connection => { - * broadcast.playFile('C:/Users/Discord/Desktop/music.mp3'); - * const dispatcher = connection.playBroadcast(broadcast); - * }) - * .catch(console.error); + * .then(connection => { + * broadcast.playFile('C:/Users/Discord/Desktop/music.mp3'); + * const dispatcher = connection.playBroadcast(broadcast); + * }) + * .catch(console.error); */ playFile(file, options = {}) { this.setVolume(options.volume || 1); diff --git a/src/client/voice/VoiceConnection.js b/src/client/voice/VoiceConnection.js index 9163db449..8dc09e5b7 100644 --- a/src/client/voice/VoiceConnection.js +++ b/src/client/voice/VoiceConnection.js @@ -11,9 +11,10 @@ const Prism = require('prism-media'); * Represents a connection to a guild's voice server. * ```js * // Obtained using: - * voiceChannel.join().then(connection => { + * voiceChannel.join() + * .then(connection => { * - * }); + * }); * ``` * @extends {EventEmitter} */ @@ -443,10 +444,10 @@ class VoiceConnection extends EventEmitter { * @example * // Play files natively * voiceChannel.join() - * .then(connection => { - * const dispatcher = connection.playFile('C:/Users/Discord/Desktop/music.mp3'); - * }) - * .catch(console.error); + * .then(connection => { + * const dispatcher = connection.playFile('C:/Users/Discord/Desktop/music.mp3'); + * }) + * .catch(console.error); */ playFile(file, options) { return this.player.playUnknownStream(`file:${file}`, options); @@ -472,11 +473,11 @@ class VoiceConnection extends EventEmitter { * const ytdl = require('ytdl-core'); * const streamOptions = { seek: 0, volume: 1 }; * voiceChannel.join() - * .then(connection => { - * const stream = ytdl('https://www.youtube.com/watch?v=XAWgeLF9EVQ', { filter : 'audioonly' }); - * const dispatcher = connection.playStream(stream, streamOptions); - * }) - * .catch(console.error); + * .then(connection => { + * const stream = ytdl('https://www.youtube.com/watch?v=XAWgeLF9EVQ', { filter : 'audioonly' }); + * const dispatcher = connection.playStream(stream, streamOptions); + * }) + * .catch(console.error); */ playStream(stream, options) { return this.player.playUnknownStream(stream, options); @@ -520,7 +521,8 @@ class VoiceConnection extends EventEmitter { } /** - * Creates a VoiceReceiver so you can start listening to voice data. It's recommended to only create one of these. + * Creates a VoiceReceiver so you can start listening to voice data. + * It's recommended to only create one of these. * @returns {VoiceReceiver} */ createReceiver() { diff --git a/src/client/voice/dispatcher/StreamDispatcher.js b/src/client/voice/dispatcher/StreamDispatcher.js index 24df9d069..beef7b9f4 100644 --- a/src/client/voice/dispatcher/StreamDispatcher.js +++ b/src/client/voice/dispatcher/StreamDispatcher.js @@ -89,12 +89,12 @@ class StreamDispatcher extends VolumeInterface { } /** - * Stops sending voice packets to the voice connection (stream may still progress however) + * Stops sending voice packets to the voice connection (stream may still progress however). */ pause() { this.setPaused(true); } /** - * Resumes sending voice packets to the voice connection (may be further on in the stream than when paused) + * Resumes sending voice packets to the voice connection (may be further on in the stream than when paused). */ resume() { this.setPaused(false); } @@ -122,7 +122,7 @@ class StreamDispatcher extends VolumeInterface { /** * Set the bitrate of the current Opus encoder. - * @param {number} bitrate New bitrate, in kbps. + * @param {number} bitrate New bitrate, in kbps * If set to 'auto', the voice channel's bitrate will be used */ setBitrate(bitrate) { @@ -140,7 +140,7 @@ class StreamDispatcher extends VolumeInterface { /** * Emitted whenever the dispatcher has debug information. * @event StreamDispatcher#debug - * @param {string} info the debug info + * @param {string} info The debug info */ this.setSpeaking(true); while (repeats--) { @@ -294,7 +294,7 @@ class StreamDispatcher extends VolumeInterface { this.emit(type, reason); /** * Emitted once the dispatcher ends. - * @param {string} [reason] the reason the dispatcher ended + * @param {string} [reason] The reason the dispatcher ended * @event StreamDispatcher#end */ if (type !== 'end') this.emit('end', `destroyed due to ${type} - ${reason}`); diff --git a/src/client/voice/opus/BaseOpusEngine.js b/src/client/voice/opus/BaseOpusEngine.js index 40c6204fd..a51044905 100644 --- a/src/client/voice/opus/BaseOpusEngine.js +++ b/src/client/voice/opus/BaseOpusEngine.js @@ -4,10 +4,10 @@ */ class BaseOpus { /** - * @param {Object} [options] The options to apply to the Opus engine. - * @param {number} [options.bitrate=48] The desired bitrate (kbps). - * @param {boolean} [options.fec=false] Whether to enable forward error correction. - * @param {number} [options.plp=0] The expected packet loss percentage. + * @param {Object} [options] The options to apply to the Opus engine + * @param {number} [options.bitrate=48] The desired bitrate (kbps) + * @param {boolean} [options.fec=false] Whether to enable forward error correction + * @param {number} [options.plp=0] The expected packet loss percentage */ constructor({ bitrate = 48, fec = false, plp = 0 } = {}) { this.ctl = { diff --git a/src/client/voice/player/AudioPlayer.js b/src/client/voice/player/AudioPlayer.js index 2a264f9e6..32bb070d1 100644 --- a/src/client/voice/player/AudioPlayer.js +++ b/src/client/voice/player/AudioPlayer.js @@ -81,7 +81,7 @@ class AudioPlayer extends EventEmitter { /** * Set the bitrate of the current Opus encoder. - * @param {number} value New bitrate, in kbps. + * @param {number} value New bitrate, in kbps * If set to 'auto', the voice channel's bitrate will be used */ setBitrate(value) { diff --git a/src/client/voice/receiver/VoiceReceiver.js b/src/client/voice/receiver/VoiceReceiver.js index 7b1b6c8e0..c568c6aed 100644 --- a/src/client/voice/receiver/VoiceReceiver.js +++ b/src/client/voice/receiver/VoiceReceiver.js @@ -10,9 +10,10 @@ nonce.fill(0); * Receives voice data from a voice connection. * ```js * // Obtained using: - * voiceChannel.join().then(connection => { - * const receiver = connection.createReceiver(); - * }); + * voiceChannel.join() + * .then(connection => { + * const receiver = connection.createReceiver(); + * }); * ``` * @extends {EventEmitter} */ diff --git a/src/client/websocket/WebSocketConnection.js b/src/client/websocket/WebSocketConnection.js index af4a20e8d..9567f5653 100644 --- a/src/client/websocket/WebSocketConnection.js +++ b/src/client/websocket/WebSocketConnection.js @@ -29,12 +29,12 @@ const WebSocket = (function findWebSocket() { class WebSocketConnection extends EventEmitter { /** * @param {WebSocketManager} manager The WebSocket manager - * @param {string} gateway WebSocket gateway to connect to + * @param {string} gateway The WebSocket gateway to connect to */ constructor(manager, gateway) { super(); /** - * WebSocket Manager of this connection + * The WebSocket Manager of this connection * @type {WebSocketManager} */ this.manager = manager; @@ -232,7 +232,7 @@ class WebSocketConnection extends EventEmitter { /** * Creates a connection to a gateway. - * @param {string} gateway Gateway to connect to + * @param {string} gateway The gateway to connect to * @param {number} [after=0] How long to wait before connecting * @param {boolean} [force=false] Whether or not to force a new connection even if one already exists * @returns {boolean} @@ -356,7 +356,7 @@ class WebSocketConnection extends EventEmitter { /** * Called whenever an error occurs with the WebSocket. - * @param {Error} error Error that occurred + * @param {Error} error The error that occurred */ onError(error) { if (error && error.message === 'uWs client connection error') { diff --git a/src/client/websocket/WebSocketManager.js b/src/client/websocket/WebSocketManager.js index aabea1d9b..9ef073f24 100644 --- a/src/client/websocket/WebSocketManager.js +++ b/src/client/websocket/WebSocketManager.js @@ -3,7 +3,7 @@ const Constants = require('../../util/Constants'); const WebSocketConnection = require('./WebSocketConnection'); /** - * WebSocket Manager of the client + * WebSocket Manager of the client. * @private */ class WebSocketManager extends EventEmitter { @@ -23,7 +23,7 @@ class WebSocketManager extends EventEmitter { } /** - * Sends a heartbeat on the available connection + * Sends a heartbeat on the available connection. * @returns {void} */ heartbeat() { @@ -67,7 +67,7 @@ class WebSocketManager extends EventEmitter { /** * Connects the client to a gateway. - * @param {string} gateway Gateway to connect to + * @param {string} gateway The gateway to connect to * @returns {boolean} */ connect(gateway) { diff --git a/src/sharding/Shard.js b/src/sharding/Shard.js index a73447b85..a1069ee9f 100644 --- a/src/sharding/Shard.js +++ b/src/sharding/Shard.js @@ -69,9 +69,11 @@ class Shard { * @param {string} prop Name of the client property to get, using periods for nesting * @returns {Promise<*>} * @example - * shard.fetchClientValue('guilds.size').then(count => { - * console.log(`${count} guilds in shard ${shard.id}`); - * }).catch(console.error); + * shard.fetchClientValue('guilds.size') + * .then(count => { + * console.log(`${count} guilds in shard ${shard.id}`); + * }) + * .catch(console.error); */ fetchClientValue(prop) { if (this._fetches.has(prop)) return this._fetches.get(prop); diff --git a/src/sharding/ShardClientUtil.js b/src/sharding/ShardClientUtil.js index b41deb5d1..0d7d4412b 100644 --- a/src/sharding/ShardClientUtil.js +++ b/src/sharding/ShardClientUtil.js @@ -49,9 +49,11 @@ class ShardClientUtil { * @param {string} prop Name of the client property to get, using periods for nesting * @returns {Promise} * @example - * client.shard.fetchClientValues('guilds.size').then(results => { - * console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`); - * }).catch(console.error); + * client.shard.fetchClientValues('guilds.size') + * .then(results => { + * console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`); + * }) + * .catch(console.error); */ fetchClientValues(prop) { return new Promise((resolve, reject) => { diff --git a/src/sharding/ShardingManager.js b/src/sharding/ShardingManager.js index e105f3e3f..aa40547bd 100644 --- a/src/sharding/ShardingManager.js +++ b/src/sharding/ShardingManager.js @@ -176,9 +176,11 @@ class ShardingManager extends EventEmitter { * @param {string} prop Name of the client property to get, using periods for nesting * @returns {Promise} * @example - * manager.fetchClientValues('guilds.size').then(results => { - * console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`); - * }).catch(console.error); + * manager.fetchClientValues('guilds.size') + * .then(results => { + * console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`); + * }) + * .catch(console.error); */ fetchClientValues(prop) { if (this.shards.size === 0) return Promise.reject(new Error('No shards have been spawned.')); diff --git a/src/structures/Channel.js b/src/structures/Channel.js index 3d492e451..5cf03a608 100644 --- a/src/structures/Channel.js +++ b/src/structures/Channel.js @@ -58,8 +58,8 @@ class Channel { * @example * // Delete the channel * channel.delete() - * .then() // Success - * .catch(console.error); // Log error + * .then() // Success + * .catch(console.error); // Log error */ delete() { return this.client.rest.methods.deleteChannel(this); diff --git a/src/structures/ClientUser.js b/src/structures/ClientUser.js index 8dcafb2b7..1ae7d6a87 100644 --- a/src/structures/ClientUser.js +++ b/src/structures/ClientUser.js @@ -89,8 +89,8 @@ class ClientUser extends User { * @example * // Set username * client.user.setUsername('discordjs') - * .then(user => console.log(`My new username is ${user.username}`)) - * .catch(console.error); + * .then(user => console.log(`My new username is ${user.username}`)) + * .catch(console.error); */ setUsername(username, password) { return this.client.rest.methods.updateCurrentUser({ username }, password); @@ -105,8 +105,8 @@ class ClientUser extends User { * @example * // Set email * client.user.setEmail('bob@gmail.com', 'some amazing password 123') - * .then(user => console.log(`My new email is ${user.email}`)) - * .catch(console.error); + * .then(user => console.log(`My new email is ${user.email}`)) + * .catch(console.error); */ setEmail(email, password) { return this.client.rest.methods.updateCurrentUser({ email }, password); @@ -121,8 +121,8 @@ class ClientUser extends User { * @example * // Set password * client.user.setPassword('some new amazing password 456', 'some amazing password 123') - * .then(user => console.log('New password set!')) - * .catch(console.error); + * .then(user => console.log('New password set!')) + * .catch(console.error); */ setPassword(newPassword, oldPassword) { return this.client.rest.methods.updateCurrentUser({ password: newPassword }, oldPassword); @@ -135,8 +135,8 @@ class ClientUser extends User { * @example * // Set avatar * client.user.setAvatar('./avatar.png') - * .then(user => console.log(`New avatar set!`)) - * .catch(console.error); + * .then(user => console.log(`New avatar set!`)) + * .catch(console.error); */ setAvatar(avatar) { if (typeof avatar === 'string' && avatar.startsWith('data:')) { @@ -215,10 +215,10 @@ class ClientUser extends User { /** * A user's status. Must be one of: - * - `online` - * - `idle` - * - `invisible` - * - `dnd` (do not disturb) + * * `online` + * * `idle` + * * `invisible` + * * `dnd` (do not disturb) * @typedef {string} PresenceStatus */ diff --git a/src/structures/Emoji.js b/src/structures/Emoji.js index 452dd6654..88d07fa78 100644 --- a/src/structures/Emoji.js +++ b/src/structures/Emoji.js @@ -114,10 +114,10 @@ class Emoji { * @param {EmojiEditData} data The new data for the emoji * @returns {Promise} * @example - * // Edit a emoji + * // Edit an emoji * emoji.edit({name: 'newemoji'}) - * .then(e => console.log(`Edited emoji ${e}`)) - * .catch(console.error); + * .then(e => console.log(`Edited emoji ${e}`)) + * .catch(console.error); */ edit(data) { return this.client.rest.methods.updateEmoji(this, data); diff --git a/src/structures/Guild.js b/src/structures/Guild.js index 598dbac69..3946aa846 100644 --- a/src/structures/Guild.js +++ b/src/structures/Guild.js @@ -219,7 +219,8 @@ class Guild { if (!this.emojis) { /** - * A collection of emojis that are in this guild. The key is the emoji's ID, the value is the emoji. + * A collection of emojis that are in this guild + * The key is the emoji's ID, the value is the emoji * @type {Collection} */ this.emojis = new Collection(); @@ -270,7 +271,7 @@ class Guild { } /** - * Gets the acronym that shows up in place of a guild icon + * The acronym that shows up in place of a guild icon. * @type {string} * @readonly */ @@ -391,7 +392,8 @@ class Guild { } /** - * Fetch a collection of invites to this guild. Resolves with a collection mapping invites by their codes. + * Fetch a collection of invites to this guild. + * Resolves with a collection mapping invites by their codes. * @returns {Promise>} */ fetchInvites() { @@ -537,11 +539,11 @@ class Guild { * @example * // Set the guild name and region * guild.edit({ - * name: 'Discord Guild', - * region: 'london', + * name: 'Discord Guild', + * region: 'london', * }) - * .then(updated => console.log(`New guild name ${updated.name} in region ${updated.region}`)) - * .catch(console.error); + * .then(updated => console.log(`New guild name ${updated.name} in region ${updated.region}`)) + * .catch(console.error); */ edit(data) { const _data = {}; @@ -737,8 +739,8 @@ class Guild { * @example * // Ban a user by ID (or with a user/guild member object) * guild.ban('some user ID') - * .then(user => console.log(`Banned ${user.username || user.id || user} from ${guild.name}`)) - * .catch(console.error); + * .then(user => console.log(`Banned ${user.username || user.id || user} from ${guild.name}`)) + * .catch(console.error); */ ban(user, options = {}) { if (typeof options === 'number') { @@ -757,8 +759,8 @@ class Guild { * @example * // Unban a user by ID (or with a user/guild member object) * guild.unban('some user ID') - * .then(user => console.log(`Unbanned ${user.username} from ${guild.name}`)) - * .catch(console.error); + * .then(user => console.log(`Unbanned ${user.username} from ${guild.name}`)) + * .catch(console.error); */ unban(user) { return this.client.rest.methods.unbanGuildMember(this, user); @@ -802,8 +804,8 @@ class Guild { * @example * // Create a new text channel * guild.createChannel('new-general', 'text') - * .then(channel => console.log(`Created new channel ${channel}`)) - * .catch(console.error); + * .then(channel => console.log(`Created new channel ${channel}`)) + * .catch(console.error); */ createChannel(name, type, overwrites) { return this.client.rest.methods.createChannel(this, name, type, overwrites); @@ -822,8 +824,8 @@ class Guild { * @returns {Promise} * @example * guild.updateChannels([{ channel: channelID, position: newChannelIndex }]) - * .then(guild => console.log(`Updated channel positions for ${guild.id}`)) - * .catch(console.error); + * .then(guild => console.log(`Updated channel positions for ${guild.id}`)) + * .catch(console.error); */ setChannelPositions(channelPositions) { return this.client.rest.methods.updateChannelPositions(this.id, channelPositions); @@ -836,16 +838,16 @@ class Guild { * @example * // Create a new role * guild.createRole() - * .then(role => console.log(`Created role ${role}`)) - * .catch(console.error); + * .then(role => console.log(`Created role ${role}`)) + * .catch(console.error); * @example * // Create a new role with data * guild.createRole({ * name: 'Super Cool People', * color: 'BLUE', * }) - * .then(role => console.log(`Created role ${role}`)) - * .catch(console.error) + * .then(role => console.log(`Created role ${role}`)) + * .catch(console.error) */ createRole(data = {}) { return this.client.rest.methods.createGuildRole(this, data); @@ -860,13 +862,13 @@ class Guild { * @example * // Create a new emoji from a url * guild.createEmoji('https://i.imgur.com/w3duR07.png', 'rip') - * .then(emoji => console.log(`Created new emoji with name ${emoji.name}!`)) - * .catch(console.error); + * .then(emoji => console.log(`Created new emoji with name ${emoji.name}!`)) + * .catch(console.error); * @example * // Create a new emoji from a file on your computer * guild.createEmoji('./memes/banana.png', 'banana') - * .then(emoji => console.log(`Created new emoji with name ${emoji.name}!`)) - * .catch(console.error); + * .then(emoji => console.log(`Created new emoji with name ${emoji.name}!`)) + * .catch(console.error); */ createEmoji(attachment, name, roles) { return new Promise(resolve => { @@ -897,8 +899,8 @@ class Guild { * @example * // Leave a guild * guild.leave() - * .then(g => console.log(`Left the guild ${g}`)) - * .catch(console.error); + * .then(g => console.log(`Left the guild ${g}`)) + * .catch(console.error); */ leave() { return this.client.rest.methods.leaveGuild(this); @@ -910,8 +912,8 @@ class Guild { * @example * // Delete a guild * guild.delete() - * .then(g => console.log(`Deleted the guild ${g}`)) - * .catch(console.error); + * .then(g => console.log(`Deleted the guild ${g}`)) + * .catch(console.error); */ delete() { return this.client.rest.methods.deleteGuild(this); diff --git a/src/structures/GuildAuditLogs.js b/src/structures/GuildAuditLogs.js index 2db442870..e2be2401d 100644 --- a/src/structures/GuildAuditLogs.js +++ b/src/structures/GuildAuditLogs.js @@ -171,7 +171,7 @@ class GuildAuditLogsEntry { this.executor = guild.client.users.get(data.user_id); /** - * An entry in the audit log representing a specific change + * An entry in the audit log representing a specific change. * @typedef {object} AuditLogChange * @property {string} key The property that was changed, e.g. `nick` for nickname changes * @property {*} [old] The old value of the change, e.g. for nicknames, the old nickname diff --git a/src/structures/GuildChannel.js b/src/structures/GuildChannel.js index 16c8ddd87..0fe2d974b 100644 --- a/src/structures/GuildChannel.js +++ b/src/structures/GuildChannel.js @@ -142,10 +142,10 @@ class GuildChannel extends Channel { * @example * // Overwrite permissions for a message author * message.channel.overwritePermissions(message.author, { - * SEND_MESSAGES: false + * SEND_MESSAGES: false * }) - * .then(() => console.log('Done!')) - * .catch(console.error); + * .then(() => console.log('Done!')) + * .catch(console.error); */ overwritePermissions(userOrRole, options) { const payload = { @@ -206,8 +206,8 @@ class GuildChannel extends Channel { * @example * // Edit a channel * channel.edit({name: 'new-channel'}) - * .then(c => console.log(`Edited channel ${c}`)) - * .catch(console.error); + * .then(c => console.log(`Edited channel ${c}`)) + * .catch(console.error); */ edit(data) { return this.client.rest.methods.updateChannel(this, data); @@ -220,8 +220,8 @@ class GuildChannel extends Channel { * @example * // Set a new channel name * channel.setName('not_general') - * .then(newChannel => console.log(`Channel's new name is ${newChannel.name}`)) - * .catch(console.error); + * .then(newChannel => console.log(`Channel's new name is ${newChannel.name}`)) + * .catch(console.error); */ setName(name) { return this.edit({ name }); @@ -235,8 +235,8 @@ class GuildChannel extends Channel { * @example * // Set a new channel position * channel.setPosition(2) - * .then(newChannel => console.log(`Channel's new position is ${newChannel.position}`)) - * .catch(console.error); + * .then(newChannel => console.log(`Channel's new position is ${newChannel.position}`)) + * .catch(console.error); */ setPosition(position, relative) { return this.guild.setChannelPosition(this, position, relative).then(() => this); @@ -249,8 +249,8 @@ class GuildChannel extends Channel { * @example * // Set a new channel topic * channel.setTopic('needs more rate limiting') - * .then(newChannel => console.log(`Channel's new topic is ${newChannel.topic}`)) - * .catch(console.error); + * .then(newChannel => console.log(`Channel's new topic is ${newChannel.topic}`)) + * .catch(console.error); */ setTopic(topic) { return this.client.rest.methods.updateChannel(this, { topic }); diff --git a/src/structures/GuildMember.js b/src/structures/GuildMember.js index 0c096120d..444727976 100644 --- a/src/structures/GuildMember.js +++ b/src/structures/GuildMember.js @@ -481,7 +481,7 @@ class GuildMember { } /** - * Ban this guild member + * Ban this guild member. * @param {Object|number|string} [options] Ban options. If a number, the number of days to delete messages for, if a * string, the ban reason. Supplying an object allows you to do both. * @param {number} [options.days=0] Number of days of messages to delete diff --git a/src/structures/Message.js b/src/structures/Message.js index 8e986114b..eec937e98 100644 --- a/src/structures/Message.js +++ b/src/structures/Message.js @@ -57,8 +57,8 @@ class Message { this.author = this.client.dataManager.newUser(data.author); /** - * Represents the author of the message as a guild member. Only available if the message comes from a guild - * where the author is still a member. + * Represents the author of the message as a guild member + * Only available if the message comes from a guild where the author is still a member * @type {?GuildMember} */ this.member = this.guild ? this.guild.member(this.author) || null : null; @@ -209,8 +209,8 @@ class Message { } /** - * The message contents with all mentions replaced by the equivalent text. If mentions cannot be resolved to a name, - * the relevant mention in the message content will not be converted + * The message contents with all mentions replaced by the equivalent text. + * If mentions cannot be resolved to a name, the relevant mention in the message content will not be converted. * @type {string} * @readonly */ @@ -254,8 +254,8 @@ class Message { * @example * // Create a reaction collector * const collector = message.createReactionCollector( - * (reaction, user) => reaction.emoji.name === '👌' && user.id === 'someID', - * { time: 15000 } + * (reaction, user) => reaction.emoji.name === '👌' && user.id === 'someID', + * { time: 15000 } * ); * collector.on('collect', r => console.log(`Collected ${r.emoji.name}`)); * collector.on('end', collected => console.log(`Collected ${collected.size} items`)); @@ -271,8 +271,8 @@ class Message { */ /** - * Similar to createCollector but in promise form. Resolves with a collection of reactions that pass the specified - * filter. + * Similar to createCollector but in promise form. + * Resolves with a collection of reactions that pass the specified filter. * @param {CollectorFilter} filter The filter function to use * @param {AwaitReactionsOptions} [options={}] Optional options to pass to the internal collector * @returns {Promise>} @@ -370,8 +370,8 @@ class Message { * @example * // Update the content of a message * message.edit('This is my new content!') - * .then(msg => console.log(`Updated the content of a message from ${msg.author}`)) - * .catch(console.error); + * .then(msg => console.log(`Updated the content of a message from ${msg.author}`)) + * .catch(console.error); */ edit(content, options) { if (!options && typeof content === 'object' && !(content instanceof Array)) { @@ -438,8 +438,8 @@ class Message { * @example * // Delete a message * message.delete() - * .then(msg => console.log(`Deleted message from ${msg.author}`)) - * .catch(console.error); + * .then(msg => console.log(`Deleted message from ${msg.author}`)) + * .catch(console.error); */ delete(timeout = 0) { if (timeout <= 0) { @@ -461,8 +461,8 @@ class Message { * @example * // Reply to a message * message.reply('Hey, I\'m a reply!') - * .then(msg => console.log(`Sent a reply to ${msg.author}`)) - * .catch(console.error); + * .then(msg => console.log(`Sent a reply to ${msg.author}`)) + * .catch(console.error); */ reply(content, options) { if (!options && typeof content === 'object' && !(content instanceof Array)) { diff --git a/src/structures/MessageCollector.js b/src/structures/MessageCollector.js index cc77a86c0..c0a51c813 100644 --- a/src/structures/MessageCollector.js +++ b/src/structures/MessageCollector.js @@ -22,7 +22,8 @@ class MessageCollector extends Collector { super(channel.client, filter, options); /** - * @type {TextBasedChannel} channel The channel + * The channel + * @type {TextBasedChannel} */ this.channel = channel; @@ -60,7 +61,7 @@ class MessageCollector extends Collector { /** * Handle an incoming message for possible collection. * @param {Message} message The message that could be collected - * @returns {?{key: Snowflake, value: Message}} Message data to collect + * @returns {?{key: Snowflake, value: Message}} * @private */ handle(message) { diff --git a/src/structures/ReactionCollector.js b/src/structures/ReactionCollector.js index a54687d32..ecdb37674 100644 --- a/src/structures/ReactionCollector.js +++ b/src/structures/ReactionCollector.js @@ -45,7 +45,7 @@ class ReactionCollector extends Collector { /** * Handle an incoming reaction for possible collection. * @param {MessageReaction} reaction The reaction to possibly collect - * @returns {?{key: Snowflake, value: MessageReaction}} Reaction data to collect + * @returns {?{key: Snowflake, value: MessageReaction}} * @private */ handle(reaction) { diff --git a/src/structures/Role.js b/src/structures/Role.js index d5ffb33b1..fb23fdff1 100644 --- a/src/structures/Role.js +++ b/src/structures/Role.js @@ -135,7 +135,7 @@ class Role { } /** - * Get an object mapping permission names to whether or not the role enables that permission + * Get an object mapping permission names to whether or not the role enables that permission. * @returns {Object} * @example * // Print the serialized role permissions @@ -206,8 +206,8 @@ class Role { * @example * // Edit a role * role.edit({name: 'new role'}) - * .then(r => console.log(`Edited role ${r}`)) - * .catch(console.error); + * .then(r => console.log(`Edited role ${r}`)) + * .catch(console.error); */ edit(data) { return this.client.rest.methods.updateGuildRole(this, data); @@ -220,8 +220,8 @@ class Role { * @example * // Set the name of the role * role.setName('new role') - * .then(r => console.log(`Edited name of role ${r}`)) - * .catch(console.error); + * .then(r => console.log(`Edited name of role ${r}`)) + * .catch(console.error); */ setName(name) { return this.edit({ name }); @@ -234,8 +234,8 @@ class Role { * @example * // Set the color of a role * role.setColor('#FF0000') - * .then(r => console.log(`Set color of role ${r}`)) - * .catch(console.error); + * .then(r => console.log(`Set color of role ${r}`)) + * .catch(console.error); */ setColor(color) { return this.edit({ color }); @@ -248,8 +248,8 @@ class Role { * @example * // Set the hoist of the role * role.setHoist(true) - * .then(r => console.log(`Role hoisted: ${r.hoist}`)) - * .catch(console.error); + * .then(r => console.log(`Role hoisted: ${r.hoist}`)) + * .catch(console.error); */ setHoist(hoist) { return this.edit({ hoist }); @@ -263,8 +263,8 @@ class Role { * @example * // Set the position of the role * role.setPosition(1) - * .then(r => console.log(`Role position: ${r.position}`)) - * .catch(console.error); + * .then(r => console.log(`Role position: ${r.position}`)) + * .catch(console.error); */ setPosition(position, relative) { return this.guild.setRolePosition(this, position, relative).then(() => this); @@ -277,8 +277,8 @@ class Role { * @example * // Set the permissions of the role * role.setPermissions(['KICK_MEMBERS', 'BAN_MEMBERS']) - * .then(r => console.log(`Role updated ${r}`)) - * .catch(console.error); + * .then(r => console.log(`Role updated ${r}`)) + * .catch(console.error); */ setPermissions(permissions) { return this.edit({ permissions }); @@ -291,8 +291,8 @@ class Role { * @example * // Make the role mentionable * role.setMentionable(true) - * .then(r => console.log(`Role updated ${r}`)) - * .catch(console.error); + * .then(r => console.log(`Role updated ${r}`)) + * .catch(console.error); */ setMentionable(mentionable) { return this.edit({ mentionable }); @@ -304,8 +304,8 @@ class Role { * @example * // Delete a role * role.delete() - * .then(r => console.log(`Deleted role ${r}`)) - * .catch(console.error); + * .then(r => console.log(`Deleted role ${r}`)) + * .catch(console.error); */ delete() { return this.client.rest.methods.deleteGuildRole(this); diff --git a/src/structures/TextChannel.js b/src/structures/TextChannel.js index d7f0a73f3..2d01517c5 100644 --- a/src/structures/TextChannel.js +++ b/src/structures/TextChannel.js @@ -63,9 +63,9 @@ class TextChannel extends GuildChannel { * @param {BufferResolvable|Base64Resolvable} avatar The avatar for the webhook * @returns {Promise} webhook The created webhook * @example - * channel.createWebhook('Snek', 'http://snek.s3.amazonaws.com/topSnek.png') - * .then(webhook => console.log(`Created webhook ${webhook}`)) - * .catch(console.error) + * channel.createWebhook('Snek', 'https://i.imgur.com/mI8XcpG.jpg') + * .then(webhook => console.log(`Created webhook ${webhook}`)) + * .catch(console.error) */ createWebhook(name, avatar) { return new Promise(resolve => { diff --git a/src/structures/UserProfile.js b/src/structures/UserProfile.js index 192bc1e63..a27d4d08d 100644 --- a/src/structures/UserProfile.js +++ b/src/structures/UserProfile.js @@ -13,7 +13,7 @@ class UserProfile { this.user = user; /** - * The client that created the instance of the the UserProfile. + * The client that created the instance of the UserProfile * @name UserProfile#client * @type {Client} * @readonly diff --git a/src/structures/VoiceChannel.js b/src/structures/VoiceChannel.js index af69a1e00..081710de0 100644 --- a/src/structures/VoiceChannel.js +++ b/src/structures/VoiceChannel.js @@ -82,8 +82,8 @@ class VoiceChannel extends GuildChannel { * @example * // Set the bitrate of a voice channel * voiceChannel.setBitrate(48) - * .then(vc => console.log(`Set bitrate to ${vc.bitrate}kbps for ${vc.name}`)) - * .catch(console.error); + * .then(vc => console.log(`Set bitrate to ${vc.bitrate}kbps for ${vc.name}`)) + * .catch(console.error); */ setBitrate(bitrate) { bitrate *= 1000; @@ -97,8 +97,8 @@ class VoiceChannel extends GuildChannel { * @example * // Set the user limit of a voice channel * voiceChannel.setUserLimit(42) - * .then(vc => console.log(`Set user limit to ${vc.userLimit} for ${vc.name}`)) - * .catch(console.error); + * .then(vc => console.log(`Set user limit to ${vc.userLimit} for ${vc.name}`)) + * .catch(console.error); */ setUserLimit(userLimit) { return this.edit({ userLimit }); @@ -110,8 +110,8 @@ class VoiceChannel extends GuildChannel { * @example * // Join a voice channel * voiceChannel.join() - * .then(connection => console.log('Connected!')) - * .catch(console.error); + * .then(connection => console.log('Connected!')) + * .catch(console.error); */ join() { if (this.client.browser) return Promise.reject(new Error('Voice connections are not available in browsers.')); diff --git a/src/structures/Webhook.js b/src/structures/Webhook.js index 23ce1e6c4..563e37200 100644 --- a/src/structures/Webhook.js +++ b/src/structures/Webhook.js @@ -94,8 +94,8 @@ class Webhook { * @example * // Send a message * webhook.send('hello!') - * .then(message => console.log(`Sent message: ${message.content}`)) - * .catch(console.error); + * .then(message => console.log(`Sent message: ${message.content}`)) + * .catch(console.error); */ send(content, options) { if (!options && typeof content === 'object' && !(content instanceof Array)) { diff --git a/src/structures/interfaces/TextBasedChannel.js b/src/structures/interfaces/TextBasedChannel.js index 6bf3a469f..07c2a7382 100644 --- a/src/structures/interfaces/TextBasedChannel.js +++ b/src/structures/interfaces/TextBasedChannel.js @@ -69,8 +69,8 @@ class TextBasedChannel { * @example * // Send a message * channel.send('hello!') - * .then(message => console.log(`Sent message: ${message.content}`)) - * .catch(console.error); + * .then(message => console.log(`Sent message: ${message.content}`)) + * .catch(console.error); */ send(content, options) { if (!options && typeof content === 'object' && !(content instanceof Array)) { @@ -158,8 +158,8 @@ class TextBasedChannel { * @example * // Get messages * channel.fetchMessages({limit: 10}) - * .then(messages => console.log(`Received ${messages.size} messages`)) - * .catch(console.error); + * .then(messages => console.log(`Received ${messages.size} messages`)) + * .catch(console.error); */ fetchMessages(options = {}) { return this.client.rest.methods.getChannelMessages(this, options).then(data => { @@ -321,8 +321,8 @@ class TextBasedChannel { * @example * // Create a message collector * const collector = channel.createMessageCollector( - * m => m.content.includes('discord'), - * { time: 15000 } + * m => m.content.includes('discord'), + * { time: 15000 } * ); * collector.on('collect', m => console.log(`Collected ${m.content}`)); * collector.on('end', collected => console.log(`Collected ${collected.size} items`)); @@ -348,8 +348,8 @@ class TextBasedChannel { * const filter = m => m.content.startsWith('!vote'); * // Errors: ['time'] treats ending because of the time limit as an error * channel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] }) - * .then(collected => console.log(collected.size)) - * .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`)); + * .then(collected => console.log(collected.size)) + * .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`)); */ awaitMessages(filter, options = {}) { return new Promise((resolve, reject) => { diff --git a/src/util/Constants.js b/src/util/Constants.js index 562445376..132b90b98 100644 --- a/src/util/Constants.js +++ b/src/util/Constants.js @@ -220,12 +220,12 @@ const Endpoints = exports.Endpoints = { /** * The current status of the client. Here are the available statuses: - * - READY - * - CONNECTING - * - RECONNECTING - * - IDLE - * - NEARLY - * - DISCONNECTED + * * READY + * * CONNECTING + * * RECONNECTING + * * IDLE + * * NEARLY + * * DISCONNECTED * @typedef {number} Status */ exports.Status = { @@ -239,11 +239,11 @@ exports.Status = { /** * The current status of a voice connection. Here are the available statuses: - * - CONNECTED - * - CONNECTING - * - AUTHENTICATING - * - RECONNECTING - * - DISCONNECTED + * * CONNECTED + * * CONNECTING + * * AUTHENTICATING + * * RECONNECTING + * * DISCONNECTED * @typedef {number} VoiceStatus */ exports.VoiceStatus = { @@ -333,41 +333,41 @@ exports.Events = { /** * The type of a websocket message event, e.g. `MESSAGE_CREATE`. Here are the available events: - * - READY - * - RESUMED - * - GUILD_SYNC - * - GUILD_CREATE - * - GUILD_DELETE - * - GUILD_UPDATE - * - GUILD_MEMBER_ADD - * - GUILD_MEMBER_REMOVE - * - GUILD_MEMBER_UPDATE - * - GUILD_MEMBERS_CHUNK - * - GUILD_ROLE_CREATE - * - GUILD_ROLE_DELETE - * - GUILD_ROLE_UPDATE - * - GUILD_BAN_ADD - * - GUILD_BAN_REMOVE - * - CHANNEL_CREATE - * - CHANNEL_DELETE - * - CHANNEL_UPDATE - * - CHANNEL_PINS_UPDATE - * - MESSAGE_CREATE - * - MESSAGE_DELETE - * - MESSAGE_UPDATE - * - MESSAGE_DELETE_BULK - * - MESSAGE_REACTION_ADD - * - MESSAGE_REACTION_REMOVE - * - MESSAGE_REACTION_REMOVE_ALL - * - USER_UPDATE - * - USER_NOTE_UPDATE - * - USER_SETTINGS_UPDATE - * - PRESENCE_UPDATE - * - VOICE_STATE_UPDATE - * - TYPING_START - * - VOICE_SERVER_UPDATE - * - RELATIONSHIP_ADD - * - RELATIONSHIP_REMOVE + * * READY + * * RESUMED + * * GUILD_SYNC + * * GUILD_CREATE + * * GUILD_DELETE + * * GUILD_UPDATE + * * GUILD_MEMBER_ADD + * * GUILD_MEMBER_REMOVE + * * GUILD_MEMBER_UPDATE + * * GUILD_MEMBERS_CHUNK + * * GUILD_ROLE_CREATE + * * GUILD_ROLE_DELETE + * * GUILD_ROLE_UPDATE + * * GUILD_BAN_ADD + * * GUILD_BAN_REMOVE + * * CHANNEL_CREATE + * * CHANNEL_DELETE + * * CHANNEL_UPDATE + * * CHANNEL_PINS_UPDATE + * * MESSAGE_CREATE + * * MESSAGE_DELETE + * * MESSAGE_UPDATE + * * MESSAGE_DELETE_BULK + * * MESSAGE_REACTION_ADD + * * MESSAGE_REACTION_REMOVE + * * MESSAGE_REACTION_REMOVE_ALL + * * USER_UPDATE + * * USER_NOTE_UPDATE + * * USER_SETTINGS_UPDATE + * * PRESENCE_UPDATE + * * VOICE_STATE_UPDATE + * * TYPING_START + * * VOICE_SERVER_UPDATE + * * RELATIONSHIP_ADD + * * RELATIONSHIP_REMOVE * @typedef {string} WSEventType */ exports.WSEvents = { @@ -409,6 +409,18 @@ exports.WSEvents = { RELATIONSHIP_REMOVE: 'RELATIONSHIP_REMOVE', }; +/** + * The type of a message, e.g. `DEFAULT`. Here are the available types: + * * DEFAULT + * * RECIPIENT_ADD + * * RECIPIENT_REMOVE + * * CALL + * * CHANNEL_NAME_CHANGE + * * CHANNEL_ICON_CHANGE + * * PINS_ADD + * * GUILD_MEMBER_JOIN + * @typedef {string} MessageType + */ exports.MessageTypes = [ 'DEFAULT', 'RECIPIENT_ADD', @@ -597,49 +609,49 @@ exports.Colors = { /** * An error encountered while performing an API request. Here are the potential errors: - * - UNKNOWN_ACCOUNT - * - UNKNOWN_APPLICATION - * - UNKNOWN_CHANNEL - * - UNKNOWN_GUILD - * - UNKNOWN_INTEGRATION - * - UNKNOWN_INVITE - * - UNKNOWN_MEMBER - * - UNKNOWN_MESSAGE - * - UNKNOWN_OVERWRITE - * - UNKNOWN_PROVIDER - * - UNKNOWN_ROLE - * - UNKNOWN_TOKEN - * - UNKNOWN_USER - * - UNKNOWN_EMOJI - * - BOT_PROHIBITED_ENDPOINT - * - BOT_ONLY_ENDPOINT - * - MAXIMUM_GUILDS - * - MAXIMUM_FRIENDS - * - MAXIMUM_PINS - * - MAXIMUM_ROLES - * - MAXIMUM_REACTIONS - * - UNAUTHORIZED - * - MISSING_ACCESS - * - INVALID_ACCOUNT_TYPE - * - CANNOT_EXECUTE_ON_DM - * - EMBED_DISABLED - * - CANNOT_EDIT_MESSAGE_BY_OTHER - * - CANNOT_SEND_EMPTY_MESSAGE - * - CANNOT_MESSAGE_USER - * - CANNOT_SEND_MESSAGES_IN_VOICE_CHANNEL - * - CHANNEL_VERIFICATION_LEVEL_TOO_HIGH - * - OAUTH2_APPLICATION_BOT_ABSENT - * - MAXIMUM_OAUTH2_APPLICATIONS - * - INVALID_OAUTH_STATE - * - MISSING_PERMISSIONS - * - INVALID_AUTHENTICATION_TOKEN - * - NOTE_TOO_LONG - * - INVALID_BULK_DELETE_QUANTITY - * - CANNOT_PIN_MESSAGE_IN_OTHER_CHANNEL - * - CANNOT_EXECUTE_ON_SYSTEM_MESSAGE - * - BULK_DELETE_MESSAGE_TOO_OLD - * - INVITE_ACCEPTED_TO_GUILD_NOT_CONTANING_BOT - * - REACTION_BLOCKED + * * UNKNOWN_ACCOUNT + * * UNKNOWN_APPLICATION + * * UNKNOWN_CHANNEL + * * UNKNOWN_GUILD + * * UNKNOWN_INTEGRATION + * * UNKNOWN_INVITE + * * UNKNOWN_MEMBER + * * UNKNOWN_MESSAGE + * * UNKNOWN_OVERWRITE + * * UNKNOWN_PROVIDER + * * UNKNOWN_ROLE + * * UNKNOWN_TOKEN + * * UNKNOWN_USER + * * UNKNOWN_EMOJI + * * BOT_PROHIBITED_ENDPOINT + * * BOT_ONLY_ENDPOINT + * * MAXIMUM_GUILDS + * * MAXIMUM_FRIENDS + * * MAXIMUM_PINS + * * MAXIMUM_ROLES + * * MAXIMUM_REACTIONS + * * UNAUTHORIZED + * * MISSING_ACCESS + * * INVALID_ACCOUNT_TYPE + * * CANNOT_EXECUTE_ON_DM + * * EMBED_DISABLED + * * CANNOT_EDIT_MESSAGE_BY_OTHER + * * CANNOT_SEND_EMPTY_MESSAGE + * * CANNOT_MESSAGE_USER + * * CANNOT_SEND_MESSAGES_IN_VOICE_CHANNEL + * * CHANNEL_VERIFICATION_LEVEL_TOO_HIGH + * * OAUTH2_APPLICATION_BOT_ABSENT + * * MAXIMUM_OAUTH2_APPLICATIONS + * * INVALID_OAUTH_STATE + * * MISSING_PERMISSIONS + * * INVALID_AUTHENTICATION_TOKEN + * * NOTE_TOO_LONG + * * INVALID_BULK_DELETE_QUANTITY + * * CANNOT_PIN_MESSAGE_IN_OTHER_CHANNEL + * * CANNOT_EXECUTE_ON_SYSTEM_MESSAGE + * * BULK_DELETE_MESSAGE_TOO_OLD + * * INVITE_ACCEPTED_TO_GUILD_NOT_CONTANING_BOT + * * REACTION_BLOCKED * @typedef {string} APIError */ exports.APIErrors = { diff --git a/src/util/Permissions.js b/src/util/Permissions.js index c24337672..bb5588f5f 100644 --- a/src/util/Permissions.js +++ b/src/util/Permissions.js @@ -103,7 +103,7 @@ class Permissions { } /** - * Gets an object mapping permission name (like `READ_MESSAGES`) to a {@link boolean} indicating whether the + * Gets an object mapping permission name (like `VIEW_CHANNEL`) to a {@link boolean} indicating whether the * permission is available. * @param {boolean} [checkAdmin=true] Whether to allow the administrator permission to override * @returns {Object} @@ -152,8 +152,8 @@ class Permissions { /** * Data that can be resolved to give a permission number. This can be: - * - A string (see {@link Permissions.FLAGS}) - * - A permission number + * * A string (see {@link Permissions.FLAGS}) + * * A permission number * @typedef {string|number} PermissionResolvable */ diff --git a/src/util/Util.js b/src/util/Util.js index 9b7d536cd..c23051a65 100644 --- a/src/util/Util.js +++ b/src/util/Util.js @@ -66,9 +66,9 @@ class Util { /** * Parses emoji info out of a string. The string must be one of: - * - A UTF-8 emoji (no ID) - * - A URL-encoded UTF-8 emoji (no ID) - * - A Discord custom emoji (`<:name:id>`) + * * A UTF-8 emoji (no ID) + * * A URL-encoded UTF-8 emoji (no ID) + * * A Discord custom emoji (`<:name:id>`) * @param {string} text Emoji string to parse * @returns {Object} Object with `name` and `id` properties * @private