Package Exports

stanza
stanza/Constants
stanza/JID
stanza/Namespaces
stanza/jingle
stanza/jxt
stanza/plugins/disco
stanza/plugins/pubsub

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

Readme

StanzaJS

Modern XMPP, with a JSON API.

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
JXT: JSON/XML Translation
- Working with Languages
- Field Definition Types
Supported XEP Formats
Creating Plugins
Using with React Native
Using PubSub
Using Stream Management

Discussion

MUC Room: discuss@stanzajs.org / Logs

These are related modules that form part of StanzaJS:

Name	Description	Source
stanza-shims	Runtime shims used by StanzaJS for node, browsers, and React Native.	Source

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.

stanza