baphomet-js/src/module/example.js

/**
 * Example module
 * Copy this, replace the relevent parts, add it to the list in index.js
 */

let { AbstractModule } = require('./abstract');

class ExampleModule extends AbstractModule {
    constructor() {
        super(
            "Example",
            "Example tasks",
            "example"
        );
        this.helpAndUsage = `Usage: example <command>
        ...`;
        this.hidden = false; //default value
        this.needGlobalConfig = false; // default value
        this.needConfig = false; // default value
        this.defaultCommand = 'search'; // name of the command to call when no recognized command name is present
    }

    /* Commands 
    * All methods starting with cmd_ will be parsed at initialization to expose those methods as commdands to the user
    */

    /**
     * Processed when !example blah is processed
     * 
     * @param  {...any} args the individual words passed after the command
     */
    cmd_blah(event, ...args) {
        return "Bla blah bla"
    }
}

exports.module = new ExampleModule();