Members
exitevents.EventModule
Event handler to notify the developer that the bot is restarting, and to close the MongoDB connection
Type
Source
onBulkDeleteevents.EventModule
Event handler to log whenever messages are deleted in bulk, and delete the purge command message if it exists
Type
Source
onErrorevents.EventModule
Event handler for <Discord.Client> and <NodeJS.Process> events which may be useful for debugging
Type
Source
onGuildCreateevents.EventModule
Event handler to initialise the <GuildConfiguration> whenever the <Client> joins a new <Guild>
Type
Source
onGuildDeleteevents.EventModule
Event handler to delete the guild's document whenever a <Guild> kicks the <Client> or the <Guild> is deleted/left
Type
Source
onMemberAddevents.EventModule
Event handler to log whenever a user joins a <Guild>, and to assign them to the guild's visitor role and send a welcome embed
Type
Source
onMemberBanevents.EventModule
Event handler to log whenever a member is banned or unbanned from a <Guild>
Type
Source
onMemberRemoveevents.EventModule
Event handler to log whenever a <GuildMember> leaves a guild, or is kicked
Type
Source
onMemberUpdateevents.EventModule
Event handler to log whenever a <GuildMember> changes their nickname, or has a role added/removed
Type
Source
onMessageevents.EventModule
Event handler to automatically add an acknowledgement emoji to messages in any <NewsChannel>, and to call handlers.commandHandler() whenever a message is created
Type
Source
onMessageDeleteevents.EventModule
Event handler to log whenever a <Message> is deleted
Type
Source
onMessageUpdateevents.EventModule
Event handler to log whenever a <Message> is updated,
Type
Source
onReactionAddevents.EventModule
Event handler to trigger handlers.manageAttendance() and handlers.updateUnsubmitted()
Type
Source
onReadyevents.EventModule
Event handler to notify the developer and execute the bot's startup routine
Type
Source
onRoleInteractionevents.EventModule
Event handler to log whenever a <Role> is created/deleted
Type
Source
onRoleUpdateevents.EventModule
Event handler to log whenever a guild <Role> is updated
Type
Source
onVoiceUpdateevents.EventModule
Event handler to log whenever a <GuildMember> joins/leaves a <VoiceChannel>, and to trigger handlers.channelPairing()
Type
Source
Type Definitions
EventHandler(event, …args) → {void}
An event handler function to execute when specified event(s) are emitted
Parameters
-
event
string
The event that was emitted
-
args
*<repeatable>
The emitted arguments
Returns
-
void
Source
EventModule
The complete <EventModule> object for one of Pronto's event module
Type
-
Object
Properties
-
bot
Array.<string>A string[] of valid <Client>#event(s) that this <EventModule> applies to
-
process
Array.<string>A string[] of valid <Process>#event(s) that this <EventModule> applies to
-
handler
events.EventHandlerThe event handler function to execute when specified event(s) are emitted
Source
EventModules
The complete <EventModules> object for all of Pronto's event modules, where each <EventHandler> is stored in the <EventHandlers> object under a string property
Type
-
Object.<string, events.EventModule>