Interface IEvent

Interface for an event.

interface IEvent {
    callback: (client: Client, ...args: any[]) => Promise<void>;
    emitter: Emitter;
    event: string;
}

Index

Properties

callback emitter event

Properties

`Readonly`callback

callback: (client: Client, ...args: any[]) => Promise<void>

Event callback.

Type Declaration

- (client: Client, ...args: any[]): Promise<void>
- Parameters
  - client: Client
    The Discord client.
  - ...args: any[]
    The arguments passed to the event.
  Returns Promise<void>
  A promise that resolves when the event is done executing.

`Readonly`emitter

emitter: Emitter

The emitter of the event.

`Readonly`event

event: string

The event name should correspond to a valid event name of the corresponding emitter, otherwise it won't work.

See

https://nodejs.org/api/process.html#process-events for the events of the process emitter.
https://discord.js.org/#/docs/main/stable/class/Client for the events of the client emitter.
https://discord-player.js.org/docs/discord-player/type/GuildQueueEvents for the events of the player emitter.