Skip to main content

Variable: Events

const Events: object

Type declaration​

ApplicationCommandPermissionsUpdate​

readonly ApplicationCommandPermissionsUpdate: ApplicationCommandPermissionsUpdate

ApplicationCommandRegistriesBulkOverwriteError​

readonly ApplicationCommandRegistriesBulkOverwriteError: "applicationCommandRegistriesBulkOverwriteError"

Emitted when an error is encountered when handling the command registries in bulk overwrite mode.

Param​

The error that was thrown

Param​

The guild id where the error was thrown

ApplicationCommandRegistriesInitialising​

readonly ApplicationCommandRegistriesInitialising: "applicationCommandRegistriesInitialising"

Emitted when the application command registries are being initialized.

ApplicationCommandRegistriesRegistered​

readonly ApplicationCommandRegistriesRegistered: "applicationCommandRegistriesRegistered"

Emitted once the application command registries have been initialized.

Param​

The initialised registries

AutoModerationActionExecution​

readonly AutoModerationActionExecution: AutoModerationActionExecution

AutoModerationRuleCreate​

readonly AutoModerationRuleCreate: AutoModerationRuleCreate

AutoModerationRuleDelete​

readonly AutoModerationRuleDelete: AutoModerationRuleDelete

AutoModerationRuleUpdate​

readonly AutoModerationRuleUpdate: AutoModerationRuleUpdate

CacheSweep​

readonly CacheSweep: CacheSweep

ChannelCreate​

readonly ChannelCreate: ChannelCreate

ChannelDelete​

readonly ChannelDelete: ChannelDelete

ChannelPinsUpdate​

readonly ChannelPinsUpdate: ChannelPinsUpdate

ChannelUpdate​

readonly ChannelUpdate: ChannelUpdate

ChatInputCommandAccepted​

readonly ChatInputCommandAccepted: "chatInputCommandAccepted"

Emitted when a chat input command passes all precondition checks, if any.

Param​

The contextual payload

ChatInputCommandDenied​

readonly ChatInputCommandDenied: "chatInputCommandDenied"

Emitted when a precondition denies a chat input command from being run.

Param​

The error reported by the precondition

Param​

The contextual payload

ChatInputCommandError​

readonly ChatInputCommandError: "chatInputCommandError"

Emitted after a chat input command runs unsuccesfully.

Param​

The error that was thrown

Param​

The contextual payload

ChatInputCommandFinish​

readonly ChatInputCommandFinish: "chatInputCommandFinish"

Emitted directly after a chat input command finished running, regardless of the outcome.

Param​

The interaction that executed the command

Param​

The command that finished running

Param​

The contextual payload

ChatInputCommandRun​

readonly ChatInputCommandRun: "chatInputCommandRun"

Emitted directly before a chat input command is run.

Param​

The interaction that executed the command

Param​

The command that is being run

Param​

The contextual payload

ChatInputCommandSuccess​

readonly ChatInputCommandSuccess: "chatInputCommandSuccess"

Emitted after a chat input command runs successfully.

Param​

The contextual payload

ClientReady​

readonly ClientReady: ClientReady

CommandApplicationCommandRegistryError​

readonly CommandApplicationCommandRegistryError: "commandApplicationCommandRegistryError"

Emitted when an error is encountered when handling the command application command registry.

Param​

The error that was thrown

Param​

The command whose registry caused the error

CommandAutocompleteInteractionError​

readonly CommandAutocompleteInteractionError: "commandAutocompleteInteractionError"

Emitted when an error is encountered when executing an autocomplete interaction handler.

Param​

The error that was encountered

Param​

The contextual payload

CommandAutocompleteInteractionSuccess​

readonly CommandAutocompleteInteractionSuccess: "commandAutocompleteInteractionSuccess"

Emitted after an autocomplete interaction handler runs successfully.

Param​

The contextual payload

CommandDoesNotHaveChatInputCommandHandler​

readonly CommandDoesNotHaveChatInputCommandHandler: "commandDoesNotHaveChatInputCommandHandler"

Emitted when a chat input command is executed but a chatInputRun method is not found.

Param​

The contextual payload

CommandDoesNotHaveContextMenuCommandHandler​

readonly CommandDoesNotHaveContextMenuCommandHandler: "commandDoesNotHaveContextMenuCommandHandler"

Emitted when a chat input command is executed but a contextMenuRun method is not found.

Param​

The contextual payload

CommandDoesNotHaveMessageCommandHandler​

readonly CommandDoesNotHaveMessageCommandHandler: "commandDoesNotHaveMessageCommandHandler"

Emitted when a message command is executed but a messageRun method is not found.

Param​

The contextual payload

ContextMenuCommandAccepted​

readonly ContextMenuCommandAccepted: "contextMenuCommandAccepted"

Emitted when a context menu command passes all precondition checks, if any.

Param​

The contextual payload

ContextMenuCommandDenied​

readonly ContextMenuCommandDenied: "contextMenuCommandDenied"

Emitted when a precondition denies a context menu command from being run.

Param​

The error reported by the precondition

Param​

The contextual payload

ContextMenuCommandError​

readonly ContextMenuCommandError: "contextMenuCommandError"

Emitted after a context menu command runs unsuccesfully.

Param​

The error that was thrown

Param​

The contextual payload

ContextMenuCommandFinish​

readonly ContextMenuCommandFinish: "contextMenuCommandFinish"

Emitted directly after a context menu command finished running, regardless of the outcome.

Param​

The interaction that executed the command

Param​

The command that finished running

Param​

The contextual payload

ContextMenuCommandRun​

readonly ContextMenuCommandRun: "contextMenuCommandRun"

Emitted directly before a context menu command is run.

Param​

The interaction that executed the command

Param​

The command that is being run

Param​

The contextual payload

ContextMenuCommandSuccess​

readonly ContextMenuCommandSuccess: "contextMenuCommandSuccess"

Emitted after a context menu command runs successfully.

Param​

The contextual payload

Debug​

readonly Debug: Debug

Error​

readonly Error: Error

GuildAuditLogEntryCreate​

readonly GuildAuditLogEntryCreate: GuildAuditLogEntryCreate

GuildAvailable​

readonly GuildAvailable: GuildAvailable

GuildBanAdd​

readonly GuildBanAdd: GuildBanAdd

GuildBanRemove​

readonly GuildBanRemove: GuildBanRemove

GuildCreate​

readonly GuildCreate: GuildCreate

GuildDelete​

readonly GuildDelete: GuildDelete

GuildEmojiCreate​

readonly GuildEmojiCreate: GuildEmojiCreate

GuildEmojiDelete​

readonly GuildEmojiDelete: GuildEmojiDelete

GuildEmojiUpdate​

readonly GuildEmojiUpdate: GuildEmojiUpdate

GuildIntegrationsUpdate​

readonly GuildIntegrationsUpdate: GuildIntegrationsUpdate

GuildMemberAdd​

readonly GuildMemberAdd: GuildMemberAdd

GuildMemberAvailable​

readonly GuildMemberAvailable: GuildMemberAvailable

GuildMemberRemove​

readonly GuildMemberRemove: GuildMemberRemove

GuildMemberUpdate​

readonly GuildMemberUpdate: GuildMemberUpdate

GuildMembersChunk​

readonly GuildMembersChunk: GuildMembersChunk

GuildRoleCreate​

readonly GuildRoleCreate: GuildRoleCreate

GuildRoleDelete​

readonly GuildRoleDelete: GuildRoleDelete

GuildRoleUpdate​

readonly GuildRoleUpdate: GuildRoleUpdate

GuildScheduledEventCreate​

readonly GuildScheduledEventCreate: GuildScheduledEventCreate

GuildScheduledEventDelete​

readonly GuildScheduledEventDelete: GuildScheduledEventDelete

GuildScheduledEventUpdate​

readonly GuildScheduledEventUpdate: GuildScheduledEventUpdate

GuildScheduledEventUserAdd​

readonly GuildScheduledEventUserAdd: GuildScheduledEventUserAdd

GuildScheduledEventUserRemove​

readonly GuildScheduledEventUserRemove: GuildScheduledEventUserRemove

GuildStickerCreate​

readonly GuildStickerCreate: GuildStickerCreate

GuildStickerDelete​

readonly GuildStickerDelete: GuildStickerDelete

GuildStickerUpdate​

readonly GuildStickerUpdate: GuildStickerUpdate

GuildUnavailable​

readonly GuildUnavailable: GuildUnavailable

GuildUpdate​

readonly GuildUpdate: GuildUpdate

InteractionCreate​

readonly InteractionCreate: InteractionCreate

InteractionHandlerError​

readonly InteractionHandlerError: "interactionHandlerError"

Emitted when an error is encountered when executing an interaction handler.

Param​

The error that was encountered

Param​

The contextual payload

InteractionHandlerParseError​

readonly InteractionHandlerParseError: "interactionHandlerParseError"

Emitted when the parse method of an interaction handler encounters an error.

Param​

The error that was encountered

Param​

The contextual payload

InteractionHandlerParseNone​

readonly InteractionHandlerParseNone: "interactionHandlerParseNone"

Emitted when the parse method of an interaction handler passes successfully (no errors are encountered) and none is returned.

Param​

The Option.None from the parse method.

Param​

The contextual payload

InteractionHandlerParseSome​

readonly InteractionHandlerParseSome: "interactionHandlerParseSome"

Emitted when the parse method of an interaction handler passes successfully (no errors are encountered) and some is returned.

Param​

The Option.Some from the parse method.

Param​

The contextual payload

InteractionHandlerParseSuccess​

readonly InteractionHandlerParseSuccess: "interactionHandlerParseSuccess"

Emitted when the parse method of an interaction handler passes successfully (no errors are encountered) Use the option parameter to determine if some or none was passed.

Param​

The Option from the parse method.

Param​

The contextual payload

Invalidated​

readonly Invalidated: Invalidated

InviteCreate​

readonly InviteCreate: InviteCreate

InviteDelete​

readonly InviteDelete: InviteDelete

ListenerError​

readonly ListenerError: "listenerError"

Emitted when an error is encountered when executing a listener.

Param​

The error that was thrown

Param​

The contextual payload

MentionPrefixOnly​

readonly MentionPrefixOnly: "mentionPrefixOnly"

Emitted when a message is created consisting of only the bot's mention.

Param​

The created message

MessageBulkDelete​

readonly MessageBulkDelete: MessageBulkDelete

MessageCommandAccepted​

readonly MessageCommandAccepted: "messageCommandAccepted"

Emitted when a message command passes all precondition checks, if any.

Param​

The contextual payload

MessageCommandDenied​

readonly MessageCommandDenied: "messageCommandDenied"

Emitted when a precondition denies a message command from being run.

Param​

The error reported by the precondition

Param​

The contextual payload

MessageCommandError​

readonly MessageCommandError: "messageCommandError"

Emitted after a message command runs unsuccesfully.

Param​

The error that was thrown

Param​

The contextual payload

MessageCommandFinish​

readonly MessageCommandFinish: "messageCommandFinish"

Emitted directly after a message command finished running, regardless of the outcome.

Param​

The message that executed the command

Param​

The command that finished running

Param​

The contextual payload

MessageCommandRun​

readonly MessageCommandRun: "messageCommandRun"

Emitted directly before a message command is run.

Param​

The message that executed the command

Param​

The command that is being run

Param​

The contextual payload

MessageCommandSuccess​

readonly MessageCommandSuccess: "messageCommandSuccess"

Emitted after a message command runs successfully.

Param​

The contextual payload

MessageCommandTypingError​

readonly MessageCommandTypingError: "messageCommandTypingError"

Emitted after the bot unsuccessfully tried to start typing when a command is executed.

Param​

The error that was thrown

Param​

The contextual payload

MessageCreate​

readonly MessageCreate: MessageCreate

MessageDelete​

readonly MessageDelete: MessageDelete

MessageReactionAdd​

readonly MessageReactionAdd: MessageReactionAdd

MessageReactionRemove​

readonly MessageReactionRemove: MessageReactionRemove

MessageReactionRemoveAll​

readonly MessageReactionRemoveAll: MessageReactionRemoveAll

MessageReactionRemoveEmoji​

readonly MessageReactionRemoveEmoji: MessageReactionRemoveEmoji

MessageUpdate​

readonly MessageUpdate: MessageUpdate

NonPrefixedMessage​

readonly NonPrefixedMessage: "nonPrefixedMessage"

Emitted when a message is created that does not start with a valid prefix.

Param​

The created message

PiecePostLoad​

readonly PiecePostLoad: "piecePostLoad"

Emitted after a piece is loaded.

Param​

The store in which the piece belongs to

Param​

The piece that was loaded

PieceUnload​

readonly PieceUnload: "pieceUnload"

Emitted when a piece is unloaded.

Param​

The store in which the piece belongs to

Param​

The piece that was unloaded

PluginLoaded​

readonly PluginLoaded: "pluginLoaded"

Emitted when a plugin is loaded.

Param​

The plugin hook that was loaded

Param​

The name of the plugin, if any

PossibleAutocompleteInteraction​

readonly PossibleAutocompleteInteraction: "possibleAutocompleteInteraction"

Emitted when an autocomplete interaction is recieved.

Param​

The interaction that was recieved

PossibleChatInputCommand​

readonly PossibleChatInputCommand: "possibleChatInputCommand"

Emitted when a chat input command interaction is recieved.

Param​

The interaction that was recieved.

PossibleContextMenuCommand​

readonly PossibleContextMenuCommand: "possibleContextMenuCommand"

Emitted when a context menu interaction is recieved.

Param​

The interaction that was recieved.

PreChatInputCommandRun​

readonly PreChatInputCommandRun: "preChatInputCommandRun"

Emitted before the chatInputRun method of a command is run.

Param​

The contextual payload

PreContextMenuCommandRun​

readonly PreContextMenuCommandRun: "preContextMenuCommandRun"

Emitted before the contextMenuRun method of a command is run.

Param​

The contextual payload

PreMessageCommandRun​

readonly PreMessageCommandRun: "preMessageCommandRun"

Emitted before the messageRun method of a command is run.

Param​

The contextual payload

PreMessageParsed​

readonly PreMessageParsed: "preMessageParsed"

Emitted when a message is created that was not sent by bots or webhooks.

Param​

The created message

PrefixedMessage​

readonly PrefixedMessage: "prefixedMessage"

Emitted when a message is created that does starts with a valid prefix.

Param​

The created message

PresenceUpdate​

readonly PresenceUpdate: PresenceUpdate

Raw​

readonly Raw: Raw

ShardDisconnect​

readonly ShardDisconnect: ShardDisconnect

ShardError​

readonly ShardError: ShardError

ShardReady​

readonly ShardReady: ShardReady

ShardReconnecting​

readonly ShardReconnecting: ShardReconnecting

ShardResume​

readonly ShardResume: ShardResume

StageInstanceCreate​

readonly StageInstanceCreate: StageInstanceCreate

StageInstanceDelete​

readonly StageInstanceDelete: StageInstanceDelete

StageInstanceUpdate​

readonly StageInstanceUpdate: StageInstanceUpdate

ThreadCreate​

readonly ThreadCreate: ThreadCreate

ThreadDelete​

readonly ThreadDelete: ThreadDelete

ThreadListSync​

readonly ThreadListSync: ThreadListSync

ThreadMemberUpdate​

readonly ThreadMemberUpdate: ThreadMemberUpdate

ThreadMembersUpdate​

readonly ThreadMembersUpdate: ThreadMembersUpdate

ThreadUpdate​

readonly ThreadUpdate: ThreadUpdate

TypingStart​

readonly TypingStart: TypingStart

UnknownChatInputCommand​

readonly UnknownChatInputCommand: "unknownChatInputCommand"

Emitted when the name of a sent chat input command does not match any loaded commands.

Param​

The contextual payload

UnknownContextMenuCommand​

readonly UnknownContextMenuCommand: "unknownContextMenuCommand"

Emitted when the name of a sent context menu command does not match any loaded commands.

Param​

The contextual payload

UnknownMessageCommand​

readonly UnknownMessageCommand: "unknownMessageCommand"

Emitted when the name of a sent message command does not match any loaded commands.

Param​

The contextual payload

UnknownMessageCommandName​

readonly UnknownMessageCommandName: "unknownMessageCommandName"

Emitted when a message starts with a valid prefix but does not include a command name.

Param​

UserUpdate​

readonly UserUpdate: UserUpdate

VoiceServerUpdate​

readonly VoiceServerUpdate: VoiceServerUpdate

VoiceStateUpdate​

readonly VoiceStateUpdate: VoiceStateUpdate

Warn​

readonly Warn: Warn

WebhooksUpdate​

readonly WebhooksUpdate: WebhooksUpdate

Defined in​

projects/framework/src/lib/types/Events.ts:27