XMPP identifiers (JID) for JavaScript
npm install @xmpp/jidXMPP identifiers (JID) for JavaScript
| JID type | local | @ | domain | / | resource | usage |
| :------: | :---: | :-: | :------------: | :-: | :--------: | :--------------------: |
| domain | | | wonderland.net | | | servers and components |
| bare | alice | @ | wonderland.net | | | users |
| full | alice | @ | wonderland.net | / | rabbithole | user resource (device) |
https://en.wikipedia.org/wiki/XMPP#Decentralization_and_addressing
npm install @xmpp/jid
``js
import jid from "@xmpp/jid";
/*
* All return an instance of jid.JID
*/
const addr = jid("alice@wonderland.net/rabbithole");
const addr = jid("alice", "wonderland.net", "rabbithole");
addr instanceof jid.JID; // true
// domain JIDs are created passing the domain as the first argument
const addr = jid("wonderland.net");
/*
* local
*/
addr.local = "alice";
addr.local; // alice
// same as
addr.setLocal("alice");
addr.getLocal(); // alice
/*
* domain
*/
addr.domain = "wonderland.net";
addr.domain; // wonderland.net
// same as
addr.setDomain("wonderland.net");
addr.getDomain(); // wonderland.net
/*
* resource
*/
addr.resource = "rabbithole";
addr.resource; // rabbithole
// same as
addr.setResource("rabbithole");
addr.getResource(); // rabbithole
addr.toString(); // alice@wonderland.net/rabbithole
addr.bare(); // returns a JID without resource
addr.equals(some_jid); // returns true if the two JIDs are equal, false otherwise
// same as
jid.equal(addr, some_jid);
`
The XEP-0106 defines a method to escape and unescape characters that aren't allowed in the local part of the JID. This library fully implement it.
`js`
const addr = jid("contact@example.net", "xmpp.net");
addr.toString(); // contact\40example.net@xmpp.net
// for display purpose only
addr.toString(true); // contact@example.net@xmpp.net
For user input, use
`js``
jid("contact@example.net", "xmpp.net");
// over
jid("contact@example.net@xmpp.net");
- RFC 7622 XMPP Address Format mostly implemented, l10n WIP
- XEP-0106 JID Escaping implemented
- XEP-0029 Definition of Jabber Identifiers (JIDs) 2003
- RFC 3920 XMPP addressing 2004
- RFC 3920 XMPP Address Format 2011