Skip to content

feat(Client): add guildAvailable event #9692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 15, 2023
Merged

feat(Client): add guildAvailable event #9692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a853eac
feat(Client): add `guildAvailable` event
kyranet Jul 10, 2023
9f9356d
refactor: sort entries alphabetically
kyranet Jul 10, 2023
b8390f3
Merge branch 'main' into feat/djs/add-guild-available-event
kodiakhq[bot] Jul 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/discord.js/src/client/websocket/handlers/GUILD_CREATE.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions packages/discord.js/src/util/Events.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -97,6 +98,7 @@ module.exports = {
Debug: 'debug',
Error: 'error',
GuildAuditLogEntryCreate: 'guildAuditLogEntryCreate',
GuildAvailable: 'guildAvailable',
GuildBanAdd: 'guildBanAdd',
GuildBanRemove: 'guildBanRemove',
GuildCreate: 'guildCreate',
Expand Down
2 changes: 2 additions & 0 deletions packages/discord.js/typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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];
Expand Down Expand Up @@ -5015,6 +5016,7 @@ export enum Events {
AutoModerationRuleUpdate = 'autoModerationRuleUpdate',
ClientReady = 'ready',
GuildAuditLogEntryCreate = 'guildAuditLogEntryCreate',
GuildAvailable = 'guildAvailable',
GuildCreate = 'guildCreate',
GuildDelete = 'guildDelete',
GuildUpdate = 'guildUpdate',
Expand Down