JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 452
  • Score
    100M100P100Q89734F
  • License MIT

Run a botkit bot on BeepBoopHQ

Package Exports

  • beepboop-botkit

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 (beepboop-botkit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

beepboop-botkit - Run a multi-team botkit bot on Beep Boop.

beepboop-botkit allows bot developers to run a Botkit based bot on the Beep Boop HQ bot hosting platform and support multiple teams.

Supporting multiple teams from a single bot process is made simpler as beepboop-botkit handles "spawning" as new teams add your bot.

Install

npm install --save beepboop-botkit

Use

var Botkit = require('botkit')
var BeepBoop = require('beepboop-botkit')

var controller = Botkit.slackbot()
var beepboop = BeepBoop.start(controller)

// listen for botkit controller events
controller.on('bot_channel_join', function (bot, message) {
  bot.reply(message, 'I\'m here!')
})

// Optionally you may want to listen to beepboop events
beepboop.on('add_resource', function (msg) {
  console.log('received request to add bot to team')
})

see examples/simple.js for an example.

Module: beepboop-botkit events

Module has exported function start

BeepBoop.start([options Object])

  • options.debug Boolean - Logs debug output if true
  • Returns an EventEmitter2 instance. For more information on the events exposed, please see the underlying beepboop module's documentation, as it is what is returned here.