docs: improve documentation (#1898)

* improve channel documentation

* forgot some stuff

* another one

* im good at this

* i did a dum

src/client/actions/ChannelDelete.js

@@ -23,7 +23,7 @@ class ChannelDeleteAction extends Action {
 /**
  * Emitted whenever a channel is deleted.
  * @event Client#channelDelete
- * @param {Channel} channel The channel that was deleted
+ * @param {GroupDMChannel|GuildChannel} channel The channel that was deleted
  */
 
 module.exports = ChannelDeleteAction;

src/client/websocket/packets/handlers/ChannelCreate.js

@@ -6,10 +6,10 @@ class ChannelCreateHandler extends AbstractHandler {
   }
 }
 
+module.exports = ChannelCreateHandler;
+
 /**
  * Emitted whenever a channel is created.
  * @event Client#channelCreate
- * @param {Channel} channel The channel that was created
+ * @param {DMChannel|GroupDMChannel|GuildChannel} channel The channel that was created
  */
-
-module.exports = ChannelCreateHandler;

src/client/websocket/packets/handlers/ChannelPinsUpdate.js

@@ -20,12 +20,12 @@ class ChannelPinsUpdate extends AbstractHandler {
   }
 }
 
+module.exports = ChannelPinsUpdate;
+
 /**
  * Emitted whenever the pins of a channel are updated. Due to the nature of the WebSocket event, not much information
  * can be provided easily here - you need to manually check the pins yourself.
  * @event Client#channelPinsUpdate
- * @param {Channel} channel The channel that the pins update occured in
+ * @param {DMChannel|GroupDMChannel|TextChannel} channel The channel that the pins update occured in
  * @param {Date} time The time of the pins update
  */
-
-module.exports = ChannelPinsUpdate;

src/client/websocket/packets/handlers/ChannelUpdate.js

@@ -15,6 +15,6 @@ module.exports = ChannelUpdateHandler;
 /**
  * Emitted whenever a channel is updated - e.g. name change, topic change.
  * @event Client#channelUpdate
- * @param {Channel} oldChannel The channel before the update
+ * @param {DMChannel|GroupDMChannel|GuildChannel} oldChannel The channel before the update
- * @param {Channel} newChannel The channel after the update
+ * @param {DMChannel|GroupDMChannel|GuildChannel} newChannel The channel after the update
  */

src/structures/Guild.js

@@ -499,7 +499,7 @@ class Guild extends Base {
    * @param {Snowflake|GuildAuditLogsEntry} [options.after] Limit to entries from after specified entry
    * @param {number} [options.limit] Limit number of entries
    * @param {UserResolvable} [options.user] Only show entries involving this user
-   * @param {string|number} [options.type] Only show entries involving this action type
+   * @param {ActionType|number} [options.type] Only show entries involving this action type
    * @returns {Promise<GuildAuditLogs>}
    */
   fetchAuditLogs(options = {}) {

src/structures/GuildAuditLogs.js

@@ -84,6 +84,19 @@ class GuildAuditLogs {
     return Promise.all(logs.entries.map(e => e.target)).then(() => logs);
   }
 
+  /**
+   * The target type of an entry, e.g. `GUILD`. Here are the available types:
+   * * GUILD
+   * * CHANNEL
+   * * USER
+   * * ROLE
+   * * INVITE
+   * * WEBHOOK
+   * * EMOJI
+   * * MESSAGE
+   * @typedef {string} TargetType
+   */
+
   /**
    * Find target type from entry action.
    * @param {number} target The action target
@@ -101,6 +114,13 @@ class GuildAuditLogs {
     return Targets.UNKNOWN;
   }
 
+  /**
+   * The action type of an entry, e.g. `CREATE`. Here are the available types:
+   * * CREATE
+   * * DELETE
+   * * UPDATE
+   * @typedef {string} ActionType
+   */
 
   /**
    * Find action type from entry action.
@@ -155,13 +175,13 @@ class GuildAuditLogsEntry {
     const targetType = GuildAuditLogs.targetType(data.action_type);
     /**
      * The target type of this entry
-     * @type {string}
+     * @type {TargetType}
      */
     this.targetType = targetType;
 
     /**
      * The action type of this entry
-     * @type {string}
+     * @type {ActionType}
      */
     this.actionType = GuildAuditLogs.actionType(data.action_type);
 
@@ -239,7 +259,7 @@ class GuildAuditLogsEntry {
     if (targetType === Targets.UNKNOWN) {
       /**
        * The target of this entry
-       * @type {Snowflake|Guild|User|Role|Emoji|Invite|Webhook}
+       * @type {TargetType}
        */
       this.target = this.changes.reduce((o, c) => {
         o[c.key] = c.new || c.old;

src/util/Collection.js

@@ -413,10 +413,10 @@ class Collection extends Map {
   }
 
   /**
-   * The sort() method sorts the elements of a collection in place and returns the collection.
+   * The sort() method sorts the elements of a collection and returns it.
    * The sort is not necessarily stable. The default sort order is according to string Unicode code points.
    * @param {Function} [compareFunction] Specifies a function that defines the sort order.
-   * if omitted, the collection is sorted according to each character's Unicode code point value,
+   * If omitted, the collection is sorted according to each character's Unicode code point value,
    * according to the string conversion of each element.
    * @returns {Collection}
    */