From b59c75e402b91d8a7ecec6f0b67180598e8ccdb5 Mon Sep 17 00:00:00 2001 From: Lewdcario Date: Mon, 5 Nov 2018 13:29:07 -0600 Subject: [PATCH] docs: add missing docstring for Client#guildDelete --- src/client/actions/GuildDelete.js | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/src/client/actions/GuildDelete.js b/src/client/actions/GuildDelete.js index 1bf237bd9..27ea1b001 100644 --- a/src/client/actions/GuildDelete.js +++ b/src/client/actions/GuildDelete.js @@ -19,6 +19,12 @@ class GuildDeleteAction extends Action { if (guild.available && data.unavailable) { // Guild is unavailable guild.available = false; + + /** + * Emitted whenever a guild becomes unavailable, likely due to a server outage. + * @event Client#guildUnavailable + * @param {Guild} guild The guild that has become unavailable + */ client.emit(Events.GUILD_UNAVAILABLE, guild); // Stops the GuildDelete packet thinking a guild was actually deleted, @@ -34,7 +40,14 @@ class GuildDeleteAction extends Action { // Delete guild client.guilds.remove(guild.id); guild.deleted = true; + + /** + * Emitted whenever a guild kicks the client or the guild is deleted/left. + * @event Client#guildDelete + * @param {Guild} guild The guild that was deleted + */ client.emit(Events.GUILD_DELETE, guild); + this.deleted.set(guild.id, guild); this.scheduleForDeletion(guild.id); } else { @@ -49,10 +62,4 @@ class GuildDeleteAction extends Action { } } -/** - * Emitted whenever a guild becomes unavailable, likely due to a server outage. - * @event Client#guildUnavailable - * @param {Guild} guild The guild that has become unavailable - */ - module.exports = GuildDeleteAction;