Alphabetize jsdoc comments and methods in classes

index.d.ts

@@ -154,10 +154,13 @@ declare namespace Eris {
     largeThreshold?: number;
     lastShardID?: number;
     latencyThreshold?: number;
+    maxReconnectAttempts?: number;
+    maxResumeAttempts?: number;
     maxShards?: number | "auto";
     messageLimit?: number;
     opusOnly?: boolean;
-    reconnectAttempts?: number;
+    rateLimiterOffset?: number;
+    requestTimeout?: number;
     reconnectDelay?: ReconnectDelayFunction;
     restMode?: boolean;
     seedVoiceConnections?: boolean;
@@ -365,6 +368,7 @@ declare namespace Eris {
     embeds: Embed[];
     mentionedBy?: any;
     mentions: string[];
+    pinned: boolean;
     roleMentions: string[];
     tts: boolean;
   }
@@ -516,6 +520,7 @@ declare namespace Eris {
     icon?: string;
     region?: string;
     roles?: PartialRole[];
+    systemChannelID: string;
     verificationLevel?: number;
   }
   interface GetPruneOptions {
@@ -1306,6 +1311,7 @@ declare namespace Eris {
     ): Promise<Emoji>;
     editGuildIntegration(guildID: string, integrationID: string, options: IntegrationOptions): Promise<void>;
     editGuildMember(guildID: string, memberID: string, options: MemberOptions, reason?: string): Promise<void>;
+    editGuildWidget(guildID: string, options: Widget): Promise<Widget>
     editMessage(channelID: string, messageID: string, content: MessageContent): Promise<Message>;
     editNickname(guildID: string, nick: string, reason?: string): Promise<void>;
     editRole(guildID: string, roleID: string, options: RoleOptions, reason?: string): Promise<Role>; // TODO not all options are available?
@@ -1348,6 +1354,7 @@ declare namespace Eris {
     getGuildPreview(guildID: string): Promise<GuildPreview>;
     getGuildVanity(guildID: string): Promise<{ code?: string; uses?: number }>;
     getGuildWebhooks(guildID: string): Promise<Webhook[]>;
+    getGuildWidget(guildID: string): Promise<Widget>;
     getInvite(inviteID: string, withCounts?: false): Promise<Invite & InviteWithoutMetadata<null>>;
     getInvite(inviteID: string, withCounts: true): Promise<Invite & InviteWithoutMetadata<boolean>>;
     getMessage(channelID: string, messageID: string): Promise<Message>;
@@ -1683,7 +1690,6 @@ declare namespace Eris {
     position: number;
     type: Exclude<ChannelTypes, 1 | 3>;
     constructor(data: BaseData, guild: Guild);
-    createInvite(options?: CreateInviteOptions, reason?: string): Promise<Invite & InviteWithoutMetadata<null>>;
     delete(reason?: string): Promise<void>;
     deletePermission(overwriteID: string, reason?: string): Promise<void>;
     edit(options: Omit<EditChannelOptions, "icon" | "ownerID">, reason?: string): Promise<this>;
@@ -1825,8 +1831,8 @@ declare namespace Eris {
     edit(content: MessageContent): Promise<Message<T>>;
     getReaction(reaction: string, limit?: number, before?: string, after?: string): Promise<User[]>;
     pin(): Promise<void>;
-    removeReactionEmoji(reaction: string): Promise<void>;
     removeReaction(reaction: string, userID?: string): Promise<void>;
+    removeReactionEmoji(reaction: string): Promise<void>;
     removeReactions(): Promise<void>;
     unpin(): Promise<void>;
   }
@@ -2095,9 +2101,9 @@ declare namespace Eris {
     type: 2;
     userLimit?: number;
     voiceMembers: Collection<Member>;
-    getInvites(): Promise<(Invite & InviteWithMetadata<VoiceChannel>)[]>;
     createInvite(options?: CreateInviteOptions, reason?: string): Promise<Invite & InviteWithoutMetadata<null, VoiceChannel>>;
-    join(options: VoiceResourceOptions): Promise<VoiceConnection>;
+    getInvites(): Promise<(Invite & InviteWithMetadata<VoiceChannel>)[]>;
+    join(options: { opusOnly?: boolean; shared?: boolean }): Promise<VoiceConnection>;
     leave(): void;
   }
 

lib/structures/Call.js

@@ -6,10 +6,10 @@ const VoiceState = require("./VoiceState");
 
 /**
 * Represents a call
-* @prop {String} id The ID of the call
-* @prop {Number} createdAt Timestamp of the call's creation
 * @prop {GroupChannel} channel The call channel
+* @prop {Number} createdAt Timestamp of the call's creation
 * @prop {Number?} endedTimestamp The timestamp of the call end
+* @prop {String} id The ID of the call
 * @prop {String[]} participants The IDs of the call participants
 * @prop {String?} region The region of the call server
 * @prop {String[]?} ringing The IDs of people that still have not responded to the call request

lib/structures/CategoryChannel.js

@@ -6,16 +6,18 @@ const GuildChannel = require("./GuildChannel");
 /**
 * Represents a guild category channel
 * @extends GuildChannel
+* @prop {Collection<GuildChannel>} channels A collection of guild channels that are part of this category
+* @prop {Client} client The client that initialized the channel
+* @prop {Number} createdAt Timestamp of the channel's creation
+* @prop {Guild} guild The guild that owns the channel
 * @prop {String} id The ID of the channel
 * @prop {String} mention A string that mentions the channel
-* @prop {Number} type The type of the channel
-* @prop {Guild} guild The guild that owns the channel
-* @prop {String?} parentID The ID of the category this channel belongs to
 * @prop {String} name The name of the channel
-* @prop {Number} position The position of the channel
 * @prop {Boolean} nsfw Whether the channel is an NSFW channel or not
+* @prop {String?} parentID The ID of the category this channel belongs to
 * @prop {Collection<PermissionOverwrite>} permissionOverwrites Collection of PermissionOverwrites in this channel
-* @prop {Collection<GuildChannel>} channels A collection of guild channels that are part of this category
+* @prop {Number} position The position of the channel
+* @prop {Number} type The type of the channel
 */
 class CategoryChannel extends GuildChannel {
     get channels() {

lib/structures/Channel.js

@@ -5,9 +5,9 @@ const {ChannelTypes} = require("../Constants");
 
 /**
 * Represents a channel. You also probably want to look at CategoryChannel, GroupChannel, NewsChannel, PrivateChannel, TextChannel, and VoiceChannel.
-* @prop {String} id The ID of the channel
 * @prop {Client} client The client that initialized the channel
 * @prop {Number} createdAt Timestamp of the channel's creation
+* @prop {String} id The ID of the channel
 * @prop {String} mention A string that mentions the channel
 * @prop {Number} type The type of the channel
 */

lib/structures/GroupChannel.js

@@ -8,15 +8,15 @@ const User = require("./User");
 /**
 * [USER ACCOUNT] Represents a group channel. See PrivateChannel docs for additional properties.
 * @extends PrivateChannel
-* @prop {String} id The ID of the channel
-* @prop {String} mention A string that mentions the channel
 * @prop {Call?} call The current group call, if any
-* @prop {Call?} lastCall The previous group call, if any
-* @prop {Collection<User>} recipients The recipients in this private channel
-* @prop {String} name The name of the group channel
 * @prop {String?} icon The hash of the group channel icon
 * @prop {String?} iconURL The URL of the group channel icon
+* @prop {String} id The ID of the channel
+* @prop {Call?} lastCall The previous group call, if any
+* @prop {String} mention A string that mentions the channel
+* @prop {String} name The name of the group channel
 * @prop {String} ownerID The ID of the user that is the group owner
+* @prop {Collection<User>} recipients The recipients in this private channel
 */
 class GroupChannel extends PrivateChannel { // (╯°□°）╯︵ ┻━┻
     constructor(data, client) {
@@ -40,16 +40,8 @@ class GroupChannel extends PrivateChannel { // (╯°□°）╯︵ ┻━┻
         }
     }
 
-    /**
-    * [USER ACCOUNT] Edit the channel's properties
-    * @arg {Object} options The properties to edit
-    * @arg {String} [options.name] The name of the channel
-    * @arg {String} [options.icon] The icon of the channel as a base64 data URI (group channels only). Note: base64 strings alone are not base64 data URI strings
-    * @arg {String} [options.ownerID] The ID of the channel owner (group channels only)
-    * @returns {Promise<GroupChannel>}
-    */
-    edit(options) {
-        return this.client.editChannel.call(this.client, this.id, options);
+    get iconURL() {
+        return this.icon ? this.client._formatImage(Endpoints.CHANNEL_ICON(this.id, this.icon)) : null;
     }
 
     /**
@@ -62,25 +54,33 @@ class GroupChannel extends PrivateChannel { // (╯°□°）╯︵ ┻━┻
     }
 
     /**
-    * [USER ACCOUNT] Remove a user from the group
-    * @arg {String} userID The ID of the target user
-    * @returns {Promise}
+    * Get the group's icon with the given format and size
+    * @arg {String} [format] The filetype of the icon ("jpg", "jpeg", "png", "gif", or "webp")
+    * @arg {Number} [size] The size of the icon (any power of two between 16 and 4096)
     */
-    removeRecipient(userID) {
-        return this.client.removeGroupRecipient.call(this.client, this.id, userID);
+    dynamicIconURL(format, size) {
+        return this.icon ? this.client._formatImage(Endpoints.CHANNEL_ICON(this.id, this.icon), format, size) : null;
     }
 
-    get iconURL() {
-        return this.icon ? this.client._formatImage(Endpoints.CHANNEL_ICON(this.id, this.icon)) : null;
+    /**
+    * [USER ACCOUNT] Edit the channel's properties
+    * @arg {Object} options The properties to edit
+    * @arg {String} [options.name] The name of the channel
+    * @arg {String} [options.icon] The icon of the channel as a base64 data URI (group channels only). Note: base64 strings alone are not base64 data URI strings
+    * @arg {String} [options.ownerID] The ID of the channel owner (group channels only)
+    * @returns {Promise<GroupChannel>}
+    */
+    edit(options) {
+        return this.client.editChannel.call(this.client, this.id, options);
     }
 
     /**
-    * Get the group's icon with the given format and size
-    * @arg {String} [format] The filetype of the icon ("jpg", "jpeg", "png", "gif", or "webp")
-    * @arg {Number} [size] The size of the icon (any power of two between 16 and 4096)
+    * [USER ACCOUNT] Remove a user from the group
+    * @arg {String} userID The ID of the target user
+    * @returns {Promise}
     */
-    dynamicIconURL(format, size) {
-        return this.icon ? this.client._formatImage(Endpoints.CHANNEL_ICON(this.id, this.icon), format, size) : null;
+    removeRecipient(userID) {
+        return this.client.removeGroupRecipient.call(this.client, this.id, userID);
     }
 
     toJSON(props = []) {