stanza

Modern XMPP in the browser, with a JSON API

  • stanza

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
stanza
1,219612.20.04 months ago12 years agoMinified + gzip package size for stanza in KB

Readme

StanzaJS
Modern XMPP, with a JSON API.

npm chat

What is this?

StanzaJS is a JavaScript/TypeScript library for using modern XMPP, and it does that by exposing everything as JSON. Unless you insist, you have no need to ever see or touch any XML when using StanzaJS.

Installing

npm install stanza

Echo Client Demo

import * as XMPP from 'stanza';

const client = XMPP.createClient({
    jid: 'echobot@example.com',
    password: 'hunter2',

    // If you have a .well-known/host-meta.json file for your
    // domain, the connection transport config can be skipped.
    transports: {
        websocket: 'wss://example.com:5281/xmpp-websocket',
        bosh: 'https://example.com:5281/http-bind'
    }
});

client.on('session:started', () => {
    client.getRoster();
    client.sendPresence();
});

client.on('chat', msg => {
    client.sendMessage({
        to: msg.from,
        body: 'You sent: ' + msg.body
    });
});

client.connect();

Documentation

  • API Reference
-   [Configuring](docs/Configuring.md)
-   [Events](docs/Events.md)
-   [Client Methods](docs/Reference.md)
-   [Working with Languages](docs/jxt/Language.md)
-   [Field Definition Types](docs/jxt/FieldTypes.md)

Discussion

MUC Room: discuss@stanzajs.org / Logs

Recommended Modules

These are some additional modules that are highly recommended for use with StanzaJS:
| Name | Description | Source | | ---------------------------------------------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------ | | staydown | Render helper that keeps an element scrolled to the bottom based on user intent. | Source | | webrtc-adapter | Shims browsers to provide a consistent WebRTC API. | Source |

License

MIT
Portions of StanzaJS are derived from prior works. See NOTICE file for details.

Created By

If you like this, follow @lancestout on Twitter.