jakehamilton / leverage-plugin-discord

🎙 A Discord plugin for Leverage

Discord for Leverage!

This is a plugin for Leverage that handles the discord type of components.

Discord Component

A Discord Component has the following interface:

import { ComponentConfig, ComponentUnit } from '@leverage/core';

export interface DiscordConfig extends ComponentConfig {
    discord?: {
        event?: string; // A `Discord.js` event name (defaults to 'message')
        command?: string; // A prefix to listen for on "message" events (defaults to '')
    };
}

export interface DiscordComponent extends ComponentUnit {
    config: DiscordConfig;

    // The `payload` is a `Discord.js` object related to the event your component is listening to
    discord: (payload: any) => void;
}

Example

import { manager } from '@leverage/core';
import { Discord, DiscordComponent } from '@leverage/plugin-discord';

const discord = new Discord();

const component: DiscordComponent = {
    is: 'component',
    type: 'discord',
    discord ({ channel }) {
        // Respond to all messages with "Hello, World!"
        channel.send('Hello, World!');
    },
};

manager.add(discord, component);

discord.login('<YOUR_BOT_TOKEN>');

Questions

Have a question? Feel free to file an issue!