Skip to main content

Listeners

Listeners are provider classes decorated with @Listener(event) that respond to Discord gateway events.

Defining a listener​

import { Listener, ListenerProvider } from '@nodecord/core';

@Listener(Events.ClientReady)
export class ReadyListener implements ListenerProvider {
    handler(client: Client) {
        console.log(`Logged in as ${client.user.tag}`);
    }
}

Registering listeners​

Add listeners to the listeners array of a module. The adapter's EventManager attaches them to the underlying Discord client on startup.

@Module({
    listeners: [ReadyListener],
})
export class AppModule {}

Available events​

The event string passed to @Listener() maps directly to the events emitted by the underlying Discord client. When using the discord.js adapter, these correspond to discord.js Client events.