xmpp-bot
v1.0.8
Published
A bot that handles commands for you
Downloads
6
Readme
xmpp-bot
A bot that handles commands for you
Usage
const XMPPBot = require('xmpp-bot');
let bot = new XMPPBot({
jid: '[email protected]',
password: 'romeo',
rooms: [
{jid: '[email protected]', nick: 'juliet'}
]
})
// register a command
bot.command('name', (answer, args, state, env) => {
... // do some work
answer(...) // answer with results
})
// or just return answer
bot.command('echo', (answer, args) => args.join(' '))
// disconnect when you're done (automatically done on process exit)
bot.disconnect();
Options
- node-xmpp-client's
rooms
: List of rooms{jid, nick}
the bot should join
Commands
Command functions are passed 4 arguments:
- answer: function that sends the provided text or XML element
- answer.broadcast: broadcast message to all rooms
- args: array of arguments
- state: an object that is saved for this command (
=env[command-name]
) - env: state shared by all commands
Commands are executed when a message sent to the bot starts with their name
or when the bot is mentioned with @nick <command> [args]
in a MUC (multi-user-chat)