Skip to content

types(ClientEventTypes): use Events as keys #11121

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+95 −82
Open

types(ClientEventTypes): use Events as keys #11121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
177 changes: 95 additions & 82 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 @@ -5435,121 +5435,134 @@ export type OmitPartialGroupDMChannel<Structure extends { channel: Channel }> =
};

export interface ClientEventTypes {
applicationCommandPermissionsUpdate: [data: ApplicationCommandPermissionsUpdateData];
autoModerationActionExecution: [autoModerationActionExecution: AutoModerationActionExecution];
autoModerationRuleCreate: [autoModerationRule: AutoModerationRule];
autoModerationRuleDelete: [autoModerationRule: AutoModerationRule];
autoModerationRuleUpdate: [
[Events.ApplicationCommandPermissionsUpdate]: [data: ApplicationCommandPermissionsUpdateData];
[Events.AutoModerationActionExecution]: [autoModerationActionExecution: AutoModerationActionExecution];
[Events.AutoModerationRuleCreate]: [autoModerationRule: AutoModerationRule];
[Events.AutoModerationRuleDelete]: [autoModerationRule: AutoModerationRule];
[Events.AutoModerationRuleUpdate]: [
oldAutoModerationRule: AutoModerationRule | null,
newAutoModerationRule: AutoModerationRule,
];
cacheSweep: [message: string];
channelCreate: [channel: NonThreadGuildBasedChannel];
channelDelete: [channel: DMChannel | NonThreadGuildBasedChannel];
channelPinsUpdate: [channel: TextBasedChannel, date: Date];
channelUpdate: [
[Events.CacheSweep]: [message: string];
[Events.ChannelCreate]: [channel: NonThreadGuildBasedChannel];
[Events.ChannelDelete]: [channel: DMChannel | NonThreadGuildBasedChannel];
[Events.ChannelPinsUpdate]: [channel: TextBasedChannel, date: Date];
[Events.ChannelUpdate]: [
oldChannel: DMChannel | NonThreadGuildBasedChannel,
newChannel: DMChannel | NonThreadGuildBasedChannel,
];
clientReady: [client: Client<true>];
debug: [message: string];
emojiCreate: [emoji: GuildEmoji];
emojiDelete: [emoji: GuildEmoji];
emojiUpdate: [oldEmoji: GuildEmoji, newEmoji: GuildEmoji];
entitlementCreate: [entitlement: Entitlement];
entitlementDelete: [entitlement: Entitlement];
entitlementUpdate: [oldEntitlement: Entitlement | null, newEntitlement: Entitlement];
error: [error: Error];
guildAuditLogEntryCreate: [auditLogEntry: GuildAuditLogsEntry, guild: Guild];
guildAvailable: [guild: Guild];
guildBanAdd: [ban: GuildBan];
guildBanRemove: [ban: GuildBan];
guildCreate: [guild: Guild];
guildDelete: [guild: Guild];
guildIntegrationsUpdate: [guild: Guild];
guildMemberAdd: [member: GuildMember];
guildMemberAvailable: [member: GuildMember | PartialGuildMember];
guildMemberRemove: [member: GuildMember | PartialGuildMember];
guildMemberUpdate: [oldMember: GuildMember | PartialGuildMember, newMember: GuildMember];
guildMembersChunk: [members: ReadonlyCollection<Snowflake, GuildMember>, guild: Guild, data: GuildMembersChunk];
guildScheduledEventCreate: [guildScheduledEvent: GuildScheduledEvent];
guildScheduledEventDelete: [guildScheduledEvent: GuildScheduledEvent | PartialGuildScheduledEvent];
guildScheduledEventUpdate: [
[Events.ClientReady]: [client: Client<true>];
[Events.Debug]: [message: string];
[Events.GuildEmojiCreate]: [emoji: GuildEmoji];
[Events.GuildEmojiDelete]: [emoji: GuildEmoji];
[Events.GuildEmojiUpdate]: [oldEmoji: GuildEmoji, newEmoji: GuildEmoji];
[Events.EntitlementCreate]: [entitlement: Entitlement];
[Events.EntitlementDelete]: [entitlement: Entitlement];
[Events.EntitlementUpdate]: [oldEntitlement: Entitlement | null, newEntitlement: Entitlement];
[Events.Error]: [error: Error];
[Events.GuildAuditLogEntryCreate]: [auditLogEntry: GuildAuditLogsEntry, guild: Guild];
[Events.GuildAvailable]: [guild: Guild];
[Events.GuildBanAdd]: [ban: GuildBan];
[Events.GuildBanRemove]: [ban: GuildBan];
[Events.GuildCreate]: [guild: Guild];
[Events.GuildDelete]: [guild: Guild];
[Events.GuildIntegrationsUpdate]: [guild: Guild];
[Events.GuildMemberAdd]: [member: GuildMember];
[Events.GuildMemberAvailable]: [member: GuildMember | PartialGuildMember];
[Events.GuildMemberRemove]: [member: GuildMember | PartialGuildMember];
[Events.GuildMemberUpdate]: [oldMember: GuildMember | PartialGuildMember, newMember: GuildMember];
[Events.GuildMembersChunk]: [
members: ReadonlyCollection<Snowflake, GuildMember>,
guild: Guild,
data: GuildMembersChunk,
];
[Events.GuildScheduledEventCreate]: [guildScheduledEvent: GuildScheduledEvent];
[Events.GuildScheduledEventDelete]: [guildScheduledEvent: GuildScheduledEvent | PartialGuildScheduledEvent];
[Events.GuildScheduledEventUpdate]: [
oldGuildScheduledEvent: GuildScheduledEvent | PartialGuildScheduledEvent | null,
newGuildScheduledEvent: GuildScheduledEvent,
];
guildScheduledEventUserAdd: [guildScheduledEvent: GuildScheduledEvent | PartialGuildScheduledEvent, user: User];
guildScheduledEventUserRemove: [guildScheduledEvent: GuildScheduledEvent | PartialGuildScheduledEvent, user: User];
guildSoundboardSoundCreate: [soundboardSound: GuildSoundboardSound];
guildSoundboardSoundDelete: [soundboardSound: GuildSoundboardSound | PartialSoundboardSound];
guildSoundboardSoundUpdate: [
[Events.GuildScheduledEventUserAdd]: [
guildScheduledEvent: GuildScheduledEvent | PartialGuildScheduledEvent,
user: User,
];
[Events.GuildScheduledEventUserRemove]: [
guildScheduledEvent: GuildScheduledEvent | PartialGuildScheduledEvent,
user: User,
];
[Events.GuildSoundboardSoundCreate]: [soundboardSound: GuildSoundboardSound];
[Events.GuildSoundboardSoundDelete]: [soundboardSound: GuildSoundboardSound | PartialSoundboardSound];
[Events.GuildSoundboardSoundUpdate]: [
oldSoundboardSound: GuildSoundboardSound | null,
newSoundboardSound: GuildSoundboardSound,
];
guildSoundboardSoundsUpdate: [soundboardSounds: ReadonlyCollection<Snowflake, GuildSoundboardSound>, guild: Guild];
guildUnavailable: [guild: Guild];
guildUpdate: [oldGuild: Guild, newGuild: Guild];
interactionCreate: [interaction: Interaction];
invalidated: [];
inviteCreate: [invite: GuildInvite];
inviteDelete: [invite: GuildInvite];
messageCreate: [message: OmitPartialGroupDMChannel<Message>];
messageDelete: [message: OmitPartialGroupDMChannel<Message | PartialMessage>];
messageDeleteBulk: [
[Events.GuildSoundboardSoundsUpdate]: [
soundboardSounds: ReadonlyCollection<Snowflake, GuildSoundboardSound>,
guild: Guild,
];
[Events.GuildUnavailable]: [guild: Guild];
[Events.GuildUpdate]: [oldGuild: Guild, newGuild: Guild];
[Events.InteractionCreate]: [interaction: Interaction];
[Events.Invalidated]: [];
[Events.InviteCreate]: [invite: GuildInvite];
[Events.InviteDelete]: [invite: GuildInvite];
[Events.MessageCreate]: [message: OmitPartialGroupDMChannel<Message>];
[Events.MessageDelete]: [message: OmitPartialGroupDMChannel<Message | PartialMessage>];
[Events.MessageBulkDelete]: [
messages: ReadonlyCollection<Snowflake, OmitPartialGroupDMChannel<Message | PartialMessage>>,
channel: GuildTextBasedChannel,
];
messagePollVoteAdd: [pollAnswer: PartialPollAnswer | PollAnswer, userId: Snowflake];
messagePollVoteRemove: [pollAnswer: PartialPollAnswer | PollAnswer, userId: Snowflake];
messageReactionAdd: [
[Events.MessagePollVoteAdd]: [pollAnswer: PartialPollAnswer | PollAnswer, userId: Snowflake];
[Events.MessagePollVoteRemove]: [pollAnswer: PartialPollAnswer | PollAnswer, userId: Snowflake];
[Events.MessageReactionAdd]: [
reaction: MessageReaction | PartialMessageReaction,
user: PartialUser | User,
details: MessageReactionEventDetails,
];
messageReactionRemove: [
[Events.MessageReactionRemove]: [
reaction: MessageReaction | PartialMessageReaction,
user: PartialUser | User,
details: MessageReactionEventDetails,
];
messageReactionRemoveAll: [
[Events.MessageReactionRemoveAll]: [
message: OmitPartialGroupDMChannel<Message | PartialMessage>,
reactions: ReadonlyCollection<Snowflake | string, MessageReaction>,
];
messageReactionRemoveEmoji: [reaction: MessageReaction | PartialMessageReaction];
messageUpdate: [
[Events.MessageReactionRemoveEmoji]: [reaction: MessageReaction | PartialMessageReaction];
[Events.MessageUpdate]: [
oldMessage: OmitPartialGroupDMChannel<Message | PartialMessage>,
newMessage: OmitPartialGroupDMChannel<Message>,
];
presenceUpdate: [oldPresence: Presence | null, newPresence: Presence];
roleCreate: [role: Role];
roleDelete: [role: Role];
roleUpdate: [oldRole: Role, newRole: Role];
soundboardSounds: [soundboardSounds: ReadonlyCollection<Snowflake, GuildSoundboardSound>, guild: Guild];
stageInstanceCreate: [stageInstance: StageInstance];
stageInstanceDelete: [stageInstance: StageInstance];
stageInstanceUpdate: [oldStageInstance: StageInstance | null, newStageInstance: StageInstance];
stickerCreate: [sticker: Sticker];
stickerDelete: [sticker: Sticker];
stickerUpdate: [oldSticker: Sticker, newSticker: Sticker];
subscriptionCreate: [subscription: Subscription];
subscriptionDelete: [subscription: Subscription];
subscriptionUpdate: [oldSubscription: Subscription | null, newSubscription: Subscription];
threadCreate: [thread: AnyThreadChannel, newlyCreated: boolean];
threadDelete: [thread: AnyThreadChannel];
threadListSync: [threads: ReadonlyCollection<Snowflake, AnyThreadChannel>, guild: Guild];
threadMemberUpdate: [oldMember: ThreadMember, newMember: ThreadMember];
threadMembersUpdate: [
[Events.PresenceUpdate]: [oldPresence: Presence | null, newPresence: Presence];
[Events.GuildRoleCreate]: [role: Role];
[Events.GuildRoleDelete]: [role: Role];
[Events.GuildRoleUpdate]: [oldRole: Role, newRole: Role];
[Events.SoundboardSounds]: [soundboardSounds: ReadonlyCollection<Snowflake, GuildSoundboardSound>, guild: Guild];
[Events.StageInstanceCreate]: [stageInstance: StageInstance];
[Events.StageInstanceDelete]: [stageInstance: StageInstance];
[Events.StageInstanceUpdate]: [oldStageInstance: StageInstance | null, newStageInstance: StageInstance];
[Events.GuildStickerCreate]: [sticker: Sticker];
[Events.GuildStickerDelete]: [sticker: Sticker];
[Events.GuildStickerUpdate]: [oldSticker: Sticker, newSticker: Sticker];
[Events.SubscriptionCreate]: [subscription: Subscription];
[Events.SubscriptionDelete]: [subscription: Subscription];
[Events.SubscriptionUpdate]: [oldSubscription: Subscription | null, newSubscription: Subscription];
[Events.ThreadCreate]: [thread: AnyThreadChannel, newlyCreated: boolean];
[Events.ThreadDelete]: [thread: AnyThreadChannel];
[Events.ThreadListSync]: [threads: ReadonlyCollection<Snowflake, AnyThreadChannel>, guild: Guild];
[Events.ThreadMemberUpdate]: [oldMember: ThreadMember, newMember: ThreadMember];
[Events.ThreadMembersUpdate]: [
addedMembers: ReadonlyCollection<Snowflake, ThreadMember>,
removedMembers: ReadonlyCollection<Snowflake, PartialThreadMember | ThreadMember>,
thread: AnyThreadChannel,
];
threadUpdate: [oldThread: AnyThreadChannel, newThread: AnyThreadChannel];
typingStart: [typing: Typing];
userUpdate: [oldUser: PartialUser | User, newUser: User];
voiceChannelEffectSend: [voiceChannelEffect: VoiceChannelEffect];
voiceStateUpdate: [oldState: VoiceState, newState: VoiceState];
warn: [message: string];
webhooksUpdate: [channel: AnnouncementChannel | ForumChannel | MediaChannel | TextChannel | VoiceChannel];
[Events.ThreadUpdate]: [oldThread: AnyThreadChannel, newThread: AnyThreadChannel];
[Events.TypingStart]: [typing: Typing];
[Events.UserUpdate]: [oldUser: PartialUser | User, newUser: User];
[Events.VoiceChannelEffectSend]: [voiceChannelEffect: VoiceChannelEffect];
[Events.VoiceStateUpdate]: [oldState: VoiceState, newState: VoiceState];
[Events.Warn]: [message: string];
[Events.WebhooksUpdate]: [channel: AnnouncementChannel | ForumChannel | MediaChannel | TextChannel | VoiceChannel];
}

export interface ClientFetchInviteOptions {
Expand Down
Loading