Package Exports

rocketchat-bot

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rocketchat-bot) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

rocketchat-bot

A bot framework for Rocket.Chat, built on bot-commander.

Usage

Load the bot like so:

const Bot = require("rocketchat-bot").Bot;

const bot = new Bot({
  server: "your.rocket.chat",
  username: "botuser",
  password: "botpass"
});

bot.start();

bot.on("ready", () => {
  bot.loadPlugins(__dirname + "/plugins");
});

Create a plugins directory, containing your named plugins (e.g. test, droll). Then create a plugin.js file in the directory:

module.exports = bot => {
  bot.command("test")
    .action(meta => {
      bot.send(meta, "Hello, world!");
    });
};

For more information on the bot object, see the bot-commander documentation.

The WebSocket and REST APIs are exposed via bot.wsAPI and bot.webAPI respectively.