Interface

ClientEvents

Callback parameter types for client events. Use with client.on(Events.X, handler).

Properties

Name	Type	Description
[Events.ChannelCreate]	`[channel: Channel]`	Emitted when any channel type is created.
[Events.ChannelDelete]	`[channel: Channel]`
[Events.ChannelMemberCountsUpdate]	`[payload: ChannelMemberCountsUpdatePayload]`
[Events.ChannelPinsUpdate]	`[payload: ChannelPinsUpdatePayload]`
[Events.ChannelRecipientAdd]	`[payload: ChannelRecipientPayload]`
[Events.ChannelRecipientRemove]	`[payload: ChannelRecipientPayload]`
[Events.ChannelUpdate]	`[oldChannel: Channel, newChannel: Channel]`
[Events.Debug]	`[message: string]`
[Events.EntranceSoundPlay]	`[data: GatewayEntranceSoundPlayDispatchData]`
[Events.Error]	`[error: Error]`
[Events.GuildAuditLogEntryCreate]	`[payload: AuditLogEntryPayload]`
[Events.GuildAvailable]	`[guild: Guild]`
[Events.GuildBanAdd]	`[ban: GuildBan]`
[Events.GuildBanRemove]	`[ban: GuildBan]`
[Events.GuildCountsUpdate]	`[payload: GuildCountsUpdatePayload]`
[Events.GuildCreate]	`[guild: Guild]`
[Events.GuildDelete]	`[guild: Guild]`
[Events.GuildEmojisUpdate]	`[payload: GuildEmojisUpdatePayload]`
[Events.GuildMemberAdd]	`[member: GuildMember]`
[Events.GuildMemberRemove]	`[member: GuildMember \| PartialGuildMember]`
[Events.GuildMembersChunk]	`[payload: GuildMembersChunkPayload]`
[Events.GuildMemberUpdate]	`[oldMember: GuildMember \| null, newMember: GuildMember]`
[Events.GuildRoleCreate]	`[role: Role]`
[Events.GuildRoleDelete]	`[role: Role \| null, guildId: string, roleId: string]`	`role` is null when the role was not cached before delete.
[Events.GuildRoleUpdate]	`[oldRole: Role \| null, role: Role]`	`oldRole` is null when the role was not cached before the update.
[Events.GuildStickersUpdate]	`[payload: GuildStickersUpdatePayload]`
[Events.GuildUnavailable]	`[guild: Guild]`
[Events.GuildUpdate]	`[oldGuild: Guild, newGuild: Guild]`
[Events.InviteCreate]	`[invite: Invite]`
[Events.InviteDelete]	`[payload: InviteDeletePayload]`
[Events.MessageCreate]	`[message: Message]`
[Events.MessageDelete]	`[message: PartialMessage]`
[Events.MessageDeleteBulk]	`[payload: MessageDeleteBulkPayload]`
[Events.MessageReactionAdd]	`[payload: MessageReactionPayload]`
[Events.MessageReactionAddMany]	`[payload: MessageReactionAddManyPayload]`
[Events.MessageReactionRemove]	`[payload: MessageReactionPayload]`
[Events.MessageReactionRemoveAll]	`[payload: MessageReactionRemoveAllPayload]`
[Events.MessageReactionRemoveEmoji]	`[payload: MessageReactionRemoveEmojiPayload]`
[Events.MessageUpdate]	`[oldMessage: Message \| null, newMessage: Message \| PartialMessage]`
[Events.PresenceUpdate]	`[payload: PresenceUpdatePayload]`
[Events.PresenceUpdateBulk]	`[payload: PresenceUpdateBulkPayload]`
[Events.Ready]	`[]`
[Events.Resumed]	`[]`
[Events.ShardDisconnect]	`[shardId: number, code: number]`	A gateway shard closed.
[Events.ShardError]	`[shardId: number, error: Error]`	A gateway shard emitted an error.
[Events.ShardingRequired]	`[payload: { shardId: number; numShards: number }]`	The gateway closed with 4011 — this bot needs more shards. Non-zero shards drop guild-less events; DMs only reach shard 0.
[Events.ShardReady]	`[shardId: number]`	A single gateway shard completed READY.
[Events.ShardReconnecting]	`[shardId: number]`	A gateway shard is reconnecting.
[Events.ShardResumed]	`[shardId: number]`	A single gateway shard successfully resumed.
[Events.TypingStart]	`[payload: TypingStartPayload]`
[Events.UserConnectionsUpdate]	`[data: GatewayUserConnectionsUpdateDispatchData]`
[Events.UserUpdate]	`[user: User]`
[Events.VoiceServerUpdate]	`[data: GatewayVoiceServerUpdateDispatchData]`
[Events.VoiceStateAck]	`[data: GatewayVoiceStateAckDispatchData]`
[Events.VoiceStatesSync]	`[data: GatewayVoiceStatesSyncData]`
[Events.VoiceStateUpdate]	`[data: GatewayVoiceStateUpdateDispatchData]`	Voice events stay wire-shaped (frozen voice package compatibility).
[Events.WebAuthnCredentialsUpdate]	`[data: GatewayWebAuthnCredentialsUpdateDispatchData]`
[Events.WebhooksUpdate]	`[payload: WebhooksUpdatePayload]`