JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 21801
  • Score
    100M100P100Q145126F
  • License ISC

XMPP identifiers (JID) for JavaScript

Package Exports

  • @xmpp/jid
  • @xmpp/jid/index.js

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

Readme

JID

XMPP 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

Install

npm install @xmpp/jid

Usage

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);

Escaping

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.

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

jid("contact@example.net", "xmpp.net");
// over
jid("contact@example.net@xmpp.net");

References

Deprecated