Event

Event

Event (e.g., Client event)

Constructor

new Event(config, sourcePath)

Source:
See:

Initializes a new Event

Parameters:
Name Type Description
config Object

Event configuration object

Properties
Name Type Attributes Default Description
name String

Event name
discordEventName String <optional>
 ''

Name of discord.js event that triggers this Event
handler function

Event function
type String <optional>
 'discord'

Event type
description String <optional>
 ''

Event description
context String <optional>
 'global'

Event context
interval String <optional>
 '1d'

Event interval
enable function <optional>
 () => {}

function that runs before enabling the Event for a context
disable function <optional>
 () => {}

function that runs before disabling the Event for a context
sourcePath String

full path of Event source file

Members

(static) guildCreate :Event

Source:
See:
Properties:
Name Type Description
guild external:Guild

discord.js Guild

Adds a Guild

Type:

(static) guildDelete :Event

Source:
See:
Properties:
Name Type Description
guild external:Guild

discord.js Guild

Removes a Guild

Type:

(static) guildMemberAdd :Event

Source:
See:
Properties:
Name Type Description
member external:GuildMember

discord.js GuildMember

Adds a User to a Guild

Type:

(static) guildMemberRemove :Event

Source:
See:
Properties:
Name Type Description
member external:GuildMember

discord.js GuildMember

Removes a User from a Guild

Type:

(static) process-monitor :Event

Source:
Tutorials:
Properties:
Name Type Description
handlerConfig Object

handler function configuration object

Properties
Name Type Description
server Esdi

Esdi server instance
context external:Guild | external:Channel | String

Event context
enableConfig Object

enable function configuration object

Properties
Name Type Description
server Esdi

Esdi server instance
context external:Guild | external:Channel | String

Event context
args Array.<String>

arguments provided following Event name
message external:Message

discord.js Message
disableConfig Object

disable function configuration object

Properties
Name Type Description
server Esdi

Esdi server instance
context external:Guild | external:Channel | String

Event context
args Array.<String>

arguments provided following Event name
message external:Message

discord.js Message

Reports the memory and processor usage of the server's process along with its uptime and Discord stats

Type:

(static) rateLimit :Event

Source:
See:
Properties:
Name Type Description
info Object

discord.js rateLimitInfo object

Logs rate limiting from Discord to the console when it occurs

Type:

(static) ready :Event

Source:
See:

Sets the id for DiscordController and initializes the Guilds to which the bot is currently connected

Type: