Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-15 02:53:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add missing docstring for Client#guildDelete

Browse Source
This commit is contained in:
Lewdcario
2018-11-05 13:29:07 -06:00
parent 905f1c3262
commit b59c75e402
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/client/actions/GuildDelete.js
View File

@@ -19,6 +19,12 @@ class GuildDeleteAction extends Action {
if (guild.available && data.unavailable) { if (guild.available && data.unavailable) {
// Guild is unavailable // Guild is unavailable
guild.available = false; 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); client.emit(Events.GUILD_UNAVAILABLE, guild);
// Stops the GuildDelete packet thinking a guild was actually deleted, // Stops the GuildDelete packet thinking a guild was actually deleted,
@@ -34,7 +40,14 @@ class GuildDeleteAction extends Action {
// Delete guild // Delete guild
client.guilds.remove(guild.id); client.guilds.remove(guild.id);
guild.deleted = true; 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); client.emit(Events.GUILD_DELETE, guild);
this.deleted.set(guild.id, guild); this.deleted.set(guild.id, guild);
this.scheduleForDeletion(guild.id); this.scheduleForDeletion(guild.id);
} else { } 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; module.exports = GuildDeleteAction;