feat(Client): add guildAvailable event (#9692)

* feat(Client): add `guildAvailable` event * refactor: sort entries alphabetically --------- Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
discordjs · Jul 15, 2023 · 3c85fb2 · 3c85fb2
1 parent 4141405
commit 3c85fb2
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/packages/discord.js/src/client/websocket/handlers/GUILD_CREATE.js b/packages/discord.js/src/client/websocket/handlers/GUILD_CREATE.js
@@ -9,6 +9,13 @@ module.exports = (client, { d: data }, shard) => {
     if (!guild.available && !data.unavailable) {
       // A newly available guild
       guild._patch(data);
+
+      /**
+       * Emitted whenever a guild becomes available.
+       * @event Client#guildAvailable
+       * @param {Guild} guild The guild that became available
+       */
+      client.emit(Events.GuildAvailable, guild);
     }
   } else {
     // A new guild

diff --git a/packages/discord.js/src/util/Events.js b/packages/discord.js/src/util/Events.js
@@ -16,6 +16,7 @@
  * @property {string} Debug debug
  * @property {string} Error error
  * @property {string} GuildAuditLogEntryCreate guildAuditLogEntryCreate
+ * @property {string} GuildAvailable guildAvailable
  * @property {string} GuildBanAdd guildBanAdd
  * @property {string} GuildBanRemove guildBanRemove
  * @property {string} GuildCreate guildCreate
@@ -97,6 +98,7 @@ module.exports = {
   Debug: 'debug',
   Error: 'error',
   GuildAuditLogEntryCreate: 'guildAuditLogEntryCreate',
+  GuildAvailable: 'guildAvailable',
   GuildBanAdd: 'guildBanAdd',
   GuildBanRemove: 'guildBanRemove',
   GuildCreate: 'guildCreate',

diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts
@@ -4807,6 +4807,7 @@ export interface ClientEvents {
   emojiUpdate: [oldEmoji: GuildEmoji, newEmoji: GuildEmoji];
   error: [error: Error];
   guildAuditLogEntryCreate: [auditLogEntry: GuildAuditLogsEntry, guild: Guild];
+  guildAvailable: [guild: Guild];
   guildBanAdd: [ban: GuildBan];
   guildBanRemove: [ban: GuildBan];
   guildCreate: [guild: Guild];
@@ -5015,6 +5016,7 @@ export enum Events {
   AutoModerationRuleUpdate = 'autoModerationRuleUpdate',
   ClientReady = 'ready',
   GuildAuditLogEntryCreate = 'guildAuditLogEntryCreate',
+  GuildAvailable = 'guildAvailable',
   GuildCreate = 'guildCreate',
   GuildDelete = 'guildDelete',
   GuildUpdate = 'guildUpdate',