ClientEvent is a string enum of all events the Client emits. Use it with client.on(ClientEvent.MessageCreate, ...) for type-safe event subscriptions instead of string literals.
import { ClientEvent } from " lunibee " ;
import { ClientEvent } from " lunibee " ;
client . on (ClientEvent . Ready , ( user ) => {
console . log ( ` đ Logged in as ${ user . username } ` );
// Equivalent string form (also valid):
client . on ( " ready " , ( user ) => { ... });
client . on ( ClientEvent . Ready , ( user ) => {
console . log ( ` đ Logged in as ${ user . username } ` );
// Equivalent string form (also valid):
client . on ( " ready " , ( user ) => { ... });
Event
String Key
Listener Args
ClientEvent.Ready
"ready"
(user: UserData)
ClientEvent.Resumed
"resumed"
()
ClientEvent.InvalidSession
"invalidSession"
(isRecoverable: boolean)
ClientEvent.Open
"open"
()
ClientEvent.Close
"close"
({ code: number, action: string })
ClientEvent.Error
"error"
(error: Error)
ClientEvent.Raw
"raw"
({ event: string, data: unknown })
Event
String Key
Listener Args
ClientEvent.MessageCreate
"messageCreate"
(message: Message)
ClientEvent.MessageUpdate
"messageUpdate"
(message: Message, previous: Message | null)
ClientEvent.MessageDelete
"messageDelete"
(data: APIMessageDeleteEvent, message?: Message)
ClientEvent.MessageDeleteBulk
"messageDeleteBulk"
(data: APIMessageDeleteBulkEvent, messages: Message[])
Event
String Key
Listener Args
ClientEvent.MessageReactionAdd
"messageReactionAdd"
(data: APIMessageReactionEvent)
ClientEvent.MessageReactionRemove
"messageReactionRemove"
(data: APIMessageReactionEvent)
ClientEvent.MessageReactionRemoveAll
"messageReactionRemoveAll"
(data: APIMessageDeleteEvent)
ClientEvent.MessageReactionRemoveEmoji
"messageReactionRemoveEmoji"
(data: APIMessageReactionRemoveEmojiEvent)
Event
String Key
Listener Args
ClientEvent.GuildCreate
"guildCreate"
(guild: APIGuild)
ClientEvent.GuildUpdate
"guildUpdate"
(guild: APIGuild, previous: Guild | null)
ClientEvent.GuildDelete
"guildDelete"
(data: { id: string, unavailable?: boolean })
ClientEvent.GuildAvailable
"guildAvailable"
(guild: APIGuild): a cached guild arriving again (e.g. after an outage)
ClientEvent.GuildUnavailable
"guildUnavailable"
(data: { id: string, unavailable?: boolean })
ClientEvent.GuildBanAdd / GuildBanRemove
"guildBanAdd" / "guildBanRemove"
(data: APIGuildBanEvent)
ClientEvent.GuildEmojisUpdate
"guildEmojisUpdate"
(data: APIGuildEmojisUpdateEvent, previous: Emoji[] | null)
ClientEvent.GuildStickersUpdate
"guildStickersUpdate"
(data: APIGuildStickersUpdateEvent, previous: APISticker[])
ClientEvent.GuildIntegrationsUpdate
"guildIntegrationsUpdate"
(data: { guild_id: string })
Event
String Key
Listener Args
ClientEvent.GuildMemberAdd
"guildMemberAdd"
(member: APIGuildMember)
ClientEvent.GuildMemberUpdate
"guildMemberUpdate"
(member: APIGuildMember, previous: GuildMember | null)
ClientEvent.GuildMemberRemove
"guildMemberRemove"
(member: APIGuildMember)
ClientEvent.GuildMembersChunk
"guildMembersChunk"
(data: APIGuildMembersChunk)
Event
String Key
Listener Args
ClientEvent.ChannelCreate
"channelCreate"
(channel: Channel)
ClientEvent.ChannelUpdate
"channelUpdate"
(channel: Channel, previous: Channel | null)
ClientEvent.ChannelDelete
"channelDelete"
(data: APIChannel, removed: Channel | null)
ClientEvent.ChannelPinsUpdate
"channelPinsUpdate"
(data: APIChannelPinsUpdate)
Event
String Key
Listener Args
ClientEvent.GuildRoleCreate
"guildRoleCreate"
(data: APIGuildRoleEvent)
ClientEvent.GuildRoleUpdate
"guildRoleUpdate"
(data: APIGuildRoleEvent, previous: Role | null)
ClientEvent.GuildRoleDelete
"guildRoleDelete"
(data: APIGuildRoleDeleteEvent, removed: Role | null)
Event
String Key
Listener Args
ClientEvent.InteractionCreate
"interactionCreate"
(interaction: Interaction)
Event
String Key
Listener Args
ClientEvent.VoiceStateUpdate
"voiceStateUpdate"
(data: APIVoiceState, previous: APIVoiceState | null)
ClientEvent.VoiceServerUpdate
"voiceServerUpdate"
(data: APIVoiceServerUpdate)
Event
String Key
Listener Args
ClientEvent.ThreadCreate
"threadCreate"
(channel: Channel)
ClientEvent.ThreadUpdate
"threadUpdate"
(channel: Channel, previous: Channel | null)
ClientEvent.ThreadDelete
"threadDelete"
(data: APIThreadEvent, removed: Channel | null)
ClientEvent.ThreadListSync
"threadListSync"
(data: APIThreadListSync)
ClientEvent.ThreadMembersUpdate
"threadMembersUpdate"
(data: APIThreadMembersUpdate)
ClientEvent.ThreadMemberUpdate
"threadMemberUpdate"
(data: APIThreadMember)
Event
String Key
Listener Args
ClientEvent.PresenceUpdate
"presenceUpdate"
(data: APIPresenceUpdate, previous: APIPresenceUpdate | null)
ClientEvent.TypingStart
"typingStart"
(data: APITypingStart)
Scheduled Events, AutoMod, Stages, Invites, Webhooks, Polls, Monetization, Soundboard Section titled âScheduled Events, AutoMod, Stages, Invites, Webhooks, Polls, Monetization, Soundboardâ
Event
Description
GuildScheduledEventCreate/Update/Delete
Guild scheduled event lifecycle.
GuildScheduledEventUserAdd / GuildScheduledEventUserRemove
A user subscribed to or left a scheduled event.
StageInstanceCreate/Update/Delete
Stage instance lifecycle.
AutoModerationRuleCreate/Update/Delete
AutoMod rule changes.
AutoModerationActionExecution
AutoMod action fired.
InviteCreate / InviteDelete
Invite creation/deletion.
WebhooksUpdate
Webhook updates.
MessagePollVoteAdd / MessagePollVoteRemove
Poll vote events.
EntitlementCreate/Update/Delete
Monetization entitlements.
SoundboardSoundCreate/Update/Delete, SoundboardSoundsUpdate
Guild soundboard changes.
Handle errors gracefully
client . on (ClientEvent . Error , ( error ) => {
console . error ( " Client error: " , error . message );
client . on ( ClientEvent . Error , ( error ) => {
console . error ( " Client error: " , error . message );
React to every message (read-only monitor)
client . on (ClientEvent . MessageCreate , ( message ) => {
if ( ! message . author . bot ) {
console . log ( ` [ ${ message . guildId ?? " DM " } ] ${ message . author . username } : ${ message . content } ` );
client . on ( ClientEvent . MessageCreate , ( message ) => {
if ( ! message . author . bot ) {
console . log ( ` [ ${ message . guildId ?? " DM " } ] ${ message . author . username } : ${ message . content } ` );
Log raw Gateway events
client . on (ClientEvent . Raw , ( { event , data } ) => {
if (event === " VOICE_STATE_UPDATE " ) {
console . log ( " Voice state: " , data);
client . on ( ClientEvent . Raw , ( { event , data } ) => {
if ( event === " VOICE_STATE_UPDATE " ) {
console . log ( " Voice state: " , data );
Update and delete events gain a trailing argument with the cached state; existing handlers keep
working. previous is a copy taken before the cache merged the update, so it keeps the old
values, and its methods (for example channel.send()) still work. It is null when the structure
was not cached (or that cache is disabled).
Event
Arguments
guildUpdate
(data, previous: Guild | null)
guildMemberUpdate
(member, previous: GuildMember | null)
guildRoleUpdate
(data, previous: Role | null)
guildRoleDelete
(data, removed: Role | null)
guildEmojisUpdate
(data, previous: Emoji[] | null) â null without the emoji cache.
guildStickersUpdate
(data, previous: APISticker[])
channelUpdate / threadUpdate
(channel, previous: Channel | null)
channelDelete / threadDelete
(data, removed: Channel | null)
client . on ( " guildRoleUpdate " , ( { role }, previous ) => {
if (previous && previous . name !== role . name )
console . log ( ` Role renamed: ${ previous . name } -> ${ role . name } ` );
Event
Arguments
messageUpdate
(message, previous) â previous is the cached version when messageCache is enabled, otherwise null.
messageDelete
(data, message?) â the cached message that was deleted, if any.
messageDeleteBulk
(data, messages) â the cached messages that were deleted (empty without messageCache).
entitlementCreate / entitlementUpdate / entitlementDelete
(entitlement)
soundboardSoundCreate / soundboardSoundUpdate
(sound)
soundboardSoundDelete
({ sound_id, guild_id })
soundboardSoundsUpdate
({ guild_id, soundboard_sounds })
Update events carry the previous state, or null when Lunibee did not have it cached.
Event
Arguments
messageUpdate
(message, previous | null) (was previous?)
voiceStateUpdate
(state, previous | null): the userâs last voice state in that guild
presenceUpdate
(presence, previous | null): needs cache: { presences: true }
stageInstanceUpdate
(stage, previous | null)
guildScheduledEventUpdate
(event, previous | null)
autoModerationRuleUpdate
(rule, previous | null)
The previous value is the object Lunibee held before the event, replaced rather than edited, so it is never changed under you.