xmpp-stream

xmpp-stream is a minimalistic, streaming bot wrapper for the simple-xmpp module.

xmpp-stream will relay any combination of the following:

• channel messages addressed to the client (default on)
• pms (default off)

These messages are available as a readable stream, and can thus be piped into a writable stream. Messages can be written like for a writable stream, and messages sent will be sent in the channel/pm.

Usage

Ideally, use it with gu as both a readable and writable stream:

var xmppParams = {
  jid : '[email protected]',
  password : password,
  host : 'talk.google.com',
  port : 5222
};
var xmppStream = require('xmpp-stream')(xmppParams, opts);
var gu = require('gu')(scriptPath, scriptFiles);

xmppStream.pipe(gu).pipe(xmppStream);

Where the argument is for simple-xmpp and is simply passed through to the simple-xmpp module.

Alternatively you could use it as just a readable stream or a writable stream. See flight-stream for an example as using it as a writable stream only.

Options

The second argument control how we listen and respond on XMPP. By default the following options are all disabled or zero:

{
  answerPms: Boolean, // respond to private messages
  friends: [], // array of friend jids to subscribe to
}

Installation

$ npm install xmpp-stream

Running tests

Install development dependencies and run test command:

$ npm install
$ npm test

License

MIT-Licensed. See LICENSE file for details.