Docs cleanup

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
+  // Send the message to a designated channel on a server:
-  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:
   const channel = member.guild.channels.find('name', 'member-log');
   // Do nothing if the channel wasn't found on this server
   if (!channel) return;

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

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 => {
+   *   .then(connection => {
-   *    const stream = ytdl('https://www.youtube.com/watch?v=XAWgeLF9EVQ', { filter : 'audioonly' });
+   *     const stream = ytdl('https://www.youtube.com/watch?v=XAWgeLF9EVQ', { filter : 'audioonly' });
-   *    broadcast.playStream(stream);
+   *     broadcast.playStream(stream);
-   *    const dispatcher = connection.playBroadcast(broadcast);
+   *     const dispatcher = connection.playBroadcast(broadcast);
-   *  })
+   *   })
-   *  .catch(console.error);
+   *   .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 => {
+   *   .then(connection => {
-   *    broadcast.playFile('C:/Users/Discord/Desktop/music.mp3');
+   *     broadcast.playFile('C:/Users/Discord/Desktop/music.mp3');
-   *    const dispatcher = connection.playBroadcast(broadcast);
+   *     const dispatcher = connection.playBroadcast(broadcast);
-   *  })
+   *   })
-   *  .catch(console.error);
+   *   .catch(console.error);
    */
   playFile(file, options = {}) {
     this.setVolume(options.volume || 1);

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 => {
+   *   .then(connection => {
-   *    const dispatcher = connection.playFile('C:/Users/Discord/Desktop/music.mp3');
+   *     const dispatcher = connection.playFile('C:/Users/Discord/Desktop/music.mp3');
-   *  })
+   *   })
-   *  .catch(console.error);
+   *   .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 => {
+   *   .then(connection => {
-   *    const stream = ytdl('https://www.youtube.com/watch?v=XAWgeLF9EVQ', { filter : 'audioonly' });
+   *     const stream = ytdl('https://www.youtube.com/watch?v=XAWgeLF9EVQ', { filter : 'audioonly' });
-   *    const dispatcher = connection.playStream(stream, streamOptions);
+   *     const dispatcher = connection.playStream(stream, streamOptions);
-   *  })
+   *   })
-   *  .catch(console.error);
+   *   .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() {

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}`);

src/client/voice/opus/BaseOpusEngine.js

@@ -4,10 +4,10 @@
  */
 class BaseOpus {
   /**
-   * @param {Object} [options] The options to apply to the Opus engine.
+   * @param {Object} [options] The options to apply to the Opus engine
-   * @param {number} [options.bitrate=48] The desired bitrate (kbps).
+   * @param {number} [options.bitrate=48] The desired bitrate (kbps)
-   * @param {boolean} [options.fec=false] Whether to enable forward error correction.
+   * @param {boolean} [options.fec=false] Whether to enable forward error correction
-   * @param {number} [options.plp=0] The expected packet loss percentage.
+   * @param {number} [options.plp=0] The expected packet loss percentage
    */
   constructor({ bitrate = 48, fec = false, plp = 0 } = {}) {
     this.ctl = {

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) {

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 => {
+ * voiceChannel.join()
- *  const receiver = connection.createReceiver();
+ *   .then(connection => {
- * });
+ *     const receiver = connection.createReceiver();
+ *   });
  * ```
  * @extends {EventEmitter}
  */

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') {

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) {

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 => {
+   * shard.fetchClientValue('guilds.size')
-   *   console.log(`${count} guilds in shard ${shard.id}`);
+   *   .then(count => {
-   * }).catch(console.error);
+   *     console.log(`${count} guilds in shard ${shard.id}`);
+   *   })
+   *   .catch(console.error);
    */
   fetchClientValue(prop) {
     if (this._fetches.has(prop)) return this._fetches.get(prop);

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<Array>}
    * @example
-   * client.shard.fetchClientValues('guilds.size').then(results => {
+   * client.shard.fetchClientValues('guilds.size')
-   *   console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`);
+   *   .then(results => {
-   * }).catch(console.error);
+   *     console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`);
+   *   })
+   *   .catch(console.error);
    */
   fetchClientValues(prop) {
     return new Promise((resolve, reject) => {

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<Array>}
    * @example
-   * manager.fetchClientValues('guilds.size').then(results => {
+   * manager.fetchClientValues('guilds.size')
-   *   console.log(`${results.reduce((prev, val) => prev + val, 0)} total guilds`);
+   *   .then(results => {
-   * }).catch(console.error);
+   *     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.'));

src/structures/Channel.js

@@ -58,8 +58,8 @@ class Channel {
    * @example
    * // Delete the channel
    * channel.delete()
-   *  .then() // Success
+   *   .then() // Success
-   *  .catch(console.error); // Log error
+   *   .catch(console.error); // Log error
    */
   delete() {
     return this.client.rest.methods.deleteChannel(this);

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}`))
+   *   .then(user => console.log(`My new username is ${user.username}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(user => console.log(`My new email is ${user.email}`))
-   *  .catch(console.error);
+   *   .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!'))
+   *   .then(user => console.log('New password set!'))
-   *  .catch(console.error);
+   *   .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!`))
+   *   .then(user => console.log(`New avatar set!`))
-   *  .catch(console.error);
+   *   .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`
+   * * `online`
-   * - `idle`
+   * * `idle`
-   * - `invisible`
+   * * `invisible`
-   * - `dnd` (do not disturb)
+   * * `dnd` (do not disturb)
    * @typedef {string} PresenceStatus
    */
 

src/structures/Emoji.js

@@ -114,10 +114,10 @@ class Emoji {
    * @param {EmojiEditData} data The new data for the emoji
    * @returns {Promise<Emoji>}
    * @example
-   * // Edit a emoji
+   * // Edit an emoji
    * emoji.edit({name: 'newemoji'})
-   *  .then(e => console.log(`Edited emoji ${e}`))
+   *   .then(e => console.log(`Edited emoji ${e}`))
-   *  .catch(console.error);
+   *   .catch(console.error);
    */
   edit(data) {
     return this.client.rest.methods.updateEmoji(this, data);

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<Snowflake, Emoji>}
        */
       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<Collection<string, Invite>>}
    */
   fetchInvites() {
@@ -537,11 +539,11 @@ class Guild {
    * @example
    * // Set the guild name and region
    * guild.edit({
-   *  name: 'Discord Guild',
+   *   name: 'Discord Guild',
-   *  region: 'london',
+   *   region: 'london',
    * })
-   * .then(updated => console.log(`New guild name ${updated.name} in region ${updated.region}`))
+   *   .then(updated => console.log(`New guild name ${updated.name} in region ${updated.region}`))
-   * .catch(console.error);
+   *   .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}`))
+   *   .then(user => console.log(`Banned ${user.username || user.id || user} from ${guild.name}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(user => console.log(`Unbanned ${user.username} from ${guild.name}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(channel => console.log(`Created new channel ${channel}`))
-   *  .catch(console.error);
+   *   .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<Guild>}
    * @example
    * guild.updateChannels([{ channel: channelID, position: newChannelIndex }])
-   *  .then(guild => console.log(`Updated channel positions for ${guild.id}`))
+   *   .then(guild => console.log(`Updated channel positions for ${guild.id}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(role => console.log(`Created role ${role}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(role => console.log(`Created role ${role}`))
-   * .catch(console.error)
+   *   .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}!`))
+   *   .then(emoji => console.log(`Created new emoji with name ${emoji.name}!`))
-   *  .catch(console.error);
+   *   .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}!`))
+   *   .then(emoji => console.log(`Created new emoji with name ${emoji.name}!`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(g => console.log(`Left the guild ${g}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(g => console.log(`Deleted the guild ${g}`))
-   *  .catch(console.error);
+   *   .catch(console.error);
    */
   delete() {
     return this.client.rest.methods.deleteGuild(this);

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

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!'))
+   *   .then(() => console.log('Done!'))
-   * .catch(console.error);
+   *   .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}`))
+   *   .then(c => console.log(`Edited channel ${c}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(newChannel => console.log(`Channel's new name is ${newChannel.name}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(newChannel => console.log(`Channel's new position is ${newChannel.position}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(newChannel => console.log(`Channel's new topic is ${newChannel.topic}`))
-   *  .catch(console.error);
+   *   .catch(console.error);
    */
   setTopic(topic) {
     return this.client.rest.methods.updateChannel(this, { topic });

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

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
+     * Represents the author of the message as a guild member
-     * where the author is still a 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 message contents with all mentions replaced by the equivalent text.
-   * the relevant mention in the message content will not be converted
+   * 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',
+   *   (reaction, user) => reaction.emoji.name === '👌' && user.id === 'someID',
-   *  { time: 15000 }
+   *   { 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
+   * Similar to createCollector but in promise form.
-   * filter.
+   * 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<Collection<string, MessageReaction>>}
@@ -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}`))
+   *   .then(msg => console.log(`Updated the content of a message from ${msg.author}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(msg => console.log(`Deleted message from ${msg.author}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(msg => console.log(`Sent a reply to ${msg.author}`))
-   *  .catch(console.error);
+   *   .catch(console.error);
    */
   reply(content, options) {
     if (!options && typeof content === 'object' && !(content instanceof Array)) {

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) {

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) {

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<string, boolean>}
    * @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}`))
+   *   .then(r => console.log(`Edited role ${r}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(r => console.log(`Edited name of role ${r}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(r => console.log(`Set color of role ${r}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(r => console.log(`Role hoisted: ${r.hoist}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(r => console.log(`Role position: ${r.position}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(r => console.log(`Role updated ${r}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(r => console.log(`Role updated ${r}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(r => console.log(`Deleted role ${r}`))
-   *  .catch(console.error);
+   *   .catch(console.error);
    */
   delete() {
     return this.client.rest.methods.deleteGuildRole(this);

src/structures/TextChannel.js

@@ -63,9 +63,9 @@ class TextChannel extends GuildChannel {
    * @param {BufferResolvable|Base64Resolvable} avatar The avatar for the webhook
    * @returns {Promise<Webhook>} webhook The created webhook
    * @example
-   * channel.createWebhook('Snek', 'http://snek.s3.amazonaws.com/topSnek.png')
+   * channel.createWebhook('Snek', 'https://i.imgur.com/mI8XcpG.jpg')
-   *  .then(webhook => console.log(`Created webhook ${webhook}`))
+   *   .then(webhook => console.log(`Created webhook ${webhook}`))
-   *  .catch(console.error)
+   *   .catch(console.error)
    */
   createWebhook(name, avatar) {
     return new Promise(resolve => {

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

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}`))
+   *   .then(vc => console.log(`Set bitrate to ${vc.bitrate}kbps for ${vc.name}`))
-   *  .catch(console.error);
+   *   .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}`))
+   *   .then(vc => console.log(`Set user limit to ${vc.userLimit} for ${vc.name}`))
-   *  .catch(console.error);
+   *   .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!'))
+   *   .then(connection => console.log('Connected!'))
-   *  .catch(console.error);
+   *   .catch(console.error);
    */
   join() {
     if (this.client.browser) return Promise.reject(new Error('Voice connections are not available in browsers.'));

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}`))
+   *   .then(message => console.log(`Sent message: ${message.content}`))
-   *  .catch(console.error);
+   *   .catch(console.error);
    */
   send(content, options) {
     if (!options && typeof content === 'object' && !(content instanceof Array)) {

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}`))
+   *   .then(message => console.log(`Sent message: ${message.content}`))
-   *  .catch(console.error);
+   *   .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`))
+   *   .then(messages => console.log(`Received ${messages.size} messages`))
-   *  .catch(console.error);
+   *   .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'),
+   *   m => m.content.includes('discord'),
-   *  { time: 15000 }
+   *   { 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))
+   *   .then(collected => console.log(collected.size))
-   *  .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));
+   *   .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));
    */
   awaitMessages(filter, options = {}) {
     return new Promise((resolve, reject) => {

src/util/Constants.js

@@ -220,12 +220,12 @@ const Endpoints = exports.Endpoints = {
 
 /**
  * The current status of the client. Here are the available statuses:
- * - READY
+ * * READY
- * - CONNECTING
+ * * CONNECTING
- * - RECONNECTING
+ * * RECONNECTING
- * - IDLE
+ * * IDLE
- * - NEARLY
+ * * NEARLY
- * - DISCONNECTED
+ * * 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
+ * * CONNECTED
- * - CONNECTING
+ * * CONNECTING
- * - AUTHENTICATING
+ * * AUTHENTICATING
- * - RECONNECTING
+ * * RECONNECTING
- * - DISCONNECTED
+ * * 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
+ * * READY
- * - RESUMED
+ * * RESUMED
- * - GUILD_SYNC
+ * * GUILD_SYNC
- * - GUILD_CREATE
+ * * GUILD_CREATE
- * - GUILD_DELETE
+ * * GUILD_DELETE
- * - GUILD_UPDATE
+ * * GUILD_UPDATE
- * - GUILD_MEMBER_ADD
+ * * GUILD_MEMBER_ADD
- * - GUILD_MEMBER_REMOVE
+ * * GUILD_MEMBER_REMOVE
- * - GUILD_MEMBER_UPDATE
+ * * GUILD_MEMBER_UPDATE
- * - GUILD_MEMBERS_CHUNK
+ * * GUILD_MEMBERS_CHUNK
- * - GUILD_ROLE_CREATE
+ * * GUILD_ROLE_CREATE
- * - GUILD_ROLE_DELETE
+ * * GUILD_ROLE_DELETE
- * - GUILD_ROLE_UPDATE
+ * * GUILD_ROLE_UPDATE
- * - GUILD_BAN_ADD
+ * * GUILD_BAN_ADD
- * - GUILD_BAN_REMOVE
+ * * GUILD_BAN_REMOVE
- * - CHANNEL_CREATE
+ * * CHANNEL_CREATE
- * - CHANNEL_DELETE
+ * * CHANNEL_DELETE
- * - CHANNEL_UPDATE
+ * * CHANNEL_UPDATE
- * - CHANNEL_PINS_UPDATE
+ * * CHANNEL_PINS_UPDATE
- * - MESSAGE_CREATE
+ * * MESSAGE_CREATE
- * - MESSAGE_DELETE
+ * * MESSAGE_DELETE
- * - MESSAGE_UPDATE
+ * * MESSAGE_UPDATE
- * - MESSAGE_DELETE_BULK
+ * * MESSAGE_DELETE_BULK
- * - MESSAGE_REACTION_ADD
+ * * MESSAGE_REACTION_ADD
- * - MESSAGE_REACTION_REMOVE
+ * * MESSAGE_REACTION_REMOVE
- * - MESSAGE_REACTION_REMOVE_ALL
+ * * MESSAGE_REACTION_REMOVE_ALL
- * - USER_UPDATE
+ * * USER_UPDATE
- * - USER_NOTE_UPDATE
+ * * USER_NOTE_UPDATE
- * - USER_SETTINGS_UPDATE
+ * * USER_SETTINGS_UPDATE
- * - PRESENCE_UPDATE
+ * * PRESENCE_UPDATE
- * - VOICE_STATE_UPDATE
+ * * VOICE_STATE_UPDATE
- * - TYPING_START
+ * * TYPING_START
- * - VOICE_SERVER_UPDATE
+ * * VOICE_SERVER_UPDATE
- * - RELATIONSHIP_ADD
+ * * RELATIONSHIP_ADD
- * - RELATIONSHIP_REMOVE
+ * * 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_ACCOUNT
- * - UNKNOWN_APPLICATION
+ * * UNKNOWN_APPLICATION
- * - UNKNOWN_CHANNEL
+ * * UNKNOWN_CHANNEL
- * - UNKNOWN_GUILD
+ * * UNKNOWN_GUILD
- * - UNKNOWN_INTEGRATION
+ * * UNKNOWN_INTEGRATION
- * - UNKNOWN_INVITE
+ * * UNKNOWN_INVITE
- * - UNKNOWN_MEMBER
+ * * UNKNOWN_MEMBER
- * - UNKNOWN_MESSAGE
+ * * UNKNOWN_MESSAGE
- * - UNKNOWN_OVERWRITE
+ * * UNKNOWN_OVERWRITE
- * - UNKNOWN_PROVIDER
+ * * UNKNOWN_PROVIDER
- * - UNKNOWN_ROLE
+ * * UNKNOWN_ROLE
- * - UNKNOWN_TOKEN
+ * * UNKNOWN_TOKEN
- * - UNKNOWN_USER
+ * * UNKNOWN_USER
- * - UNKNOWN_EMOJI
+ * * UNKNOWN_EMOJI
- * - BOT_PROHIBITED_ENDPOINT
+ * * BOT_PROHIBITED_ENDPOINT
- * - BOT_ONLY_ENDPOINT
+ * * BOT_ONLY_ENDPOINT
- * - MAXIMUM_GUILDS
+ * * MAXIMUM_GUILDS
- * - MAXIMUM_FRIENDS
+ * * MAXIMUM_FRIENDS
- * - MAXIMUM_PINS
+ * * MAXIMUM_PINS
- * - MAXIMUM_ROLES
+ * * MAXIMUM_ROLES
- * - MAXIMUM_REACTIONS
+ * * MAXIMUM_REACTIONS
- * - UNAUTHORIZED
+ * * UNAUTHORIZED
- * - MISSING_ACCESS
+ * * MISSING_ACCESS
- * - INVALID_ACCOUNT_TYPE
+ * * INVALID_ACCOUNT_TYPE
- * - CANNOT_EXECUTE_ON_DM
+ * * CANNOT_EXECUTE_ON_DM
- * - EMBED_DISABLED
+ * * EMBED_DISABLED
- * - CANNOT_EDIT_MESSAGE_BY_OTHER
+ * * CANNOT_EDIT_MESSAGE_BY_OTHER
- * - CANNOT_SEND_EMPTY_MESSAGE
+ * * CANNOT_SEND_EMPTY_MESSAGE
- * - CANNOT_MESSAGE_USER
+ * * CANNOT_MESSAGE_USER
- * - CANNOT_SEND_MESSAGES_IN_VOICE_CHANNEL
+ * * CANNOT_SEND_MESSAGES_IN_VOICE_CHANNEL
- * - CHANNEL_VERIFICATION_LEVEL_TOO_HIGH
+ * * CHANNEL_VERIFICATION_LEVEL_TOO_HIGH
- * - OAUTH2_APPLICATION_BOT_ABSENT
+ * * OAUTH2_APPLICATION_BOT_ABSENT
- * - MAXIMUM_OAUTH2_APPLICATIONS
+ * * MAXIMUM_OAUTH2_APPLICATIONS
- * - INVALID_OAUTH_STATE
+ * * INVALID_OAUTH_STATE
- * - MISSING_PERMISSIONS
+ * * MISSING_PERMISSIONS
- * - INVALID_AUTHENTICATION_TOKEN
+ * * INVALID_AUTHENTICATION_TOKEN
- * - NOTE_TOO_LONG
+ * * NOTE_TOO_LONG
- * - INVALID_BULK_DELETE_QUANTITY
+ * * INVALID_BULK_DELETE_QUANTITY
- * - CANNOT_PIN_MESSAGE_IN_OTHER_CHANNEL
+ * * CANNOT_PIN_MESSAGE_IN_OTHER_CHANNEL
- * - CANNOT_EXECUTE_ON_SYSTEM_MESSAGE
+ * * CANNOT_EXECUTE_ON_SYSTEM_MESSAGE
- * - BULK_DELETE_MESSAGE_TOO_OLD
+ * * BULK_DELETE_MESSAGE_TOO_OLD
- * - INVITE_ACCEPTED_TO_GUILD_NOT_CONTANING_BOT
+ * * INVITE_ACCEPTED_TO_GUILD_NOT_CONTANING_BOT
- * - REACTION_BLOCKED
+ * * REACTION_BLOCKED
  * @typedef {string} APIError
  */
 exports.APIErrors = {

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 string (see {@link Permissions.FLAGS})
-   * - A permission number
+   * * A permission number
    * @typedef {string|number} PermissionResolvable
    */
 

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 UTF-8 emoji (no ID)
-   * - A URL-encoded UTF-8 emoji (no ID)
+   * * A URL-encoded UTF-8 emoji (no ID)
-   * - A Discord custom emoji (`<:name:id>`)
+   * * A Discord custom emoji (`<:name:id>`)
    * @param {string} text Emoji string to parse
    * @returns {Object} Object with `name` and `id` properties
    * @private