@types/node-xmpp-core

Installation

npm install --save @types/node-xmpp-core

Summary

This package contains type definitions for node-xmpp-core (https://github.com/node-xmpp/node-xmpp).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-xmpp-core.

index.d.ts

/// <reference types="node" />
import { EventEmitter } from "events";
import { Element } from "ltx";

// fixme: not ideal
export { createElement, Element, escapeXML, escapeXMLText } from "ltx";

export class Connection extends EventEmitter {
    constructor(opts?: any);
}

export namespace SRV {
    /**
     * returns a lazy iterator which can be restarted via connection.connect()
     */
    function connect(opts?: any): any;
}

export class Stanza extends Element {
    from: string;
    to: string;
    id: string;
    type: string;

    constructor(name: string, attrs?: any);
}

/**
 * JSX compatible API, use this function as pragma
 * https://facebook.github.io/jsx/
 * Returns a Stanza if name is presence, message or iq an ltx Element otherwise.
 *
 * @param name  name of the element
 * @param attrs attribute key/value pairs
 */
export function createStanza(name: string, attrs?: any): Element;

export class IQ extends Stanza {
    constructor(attrs?: any);
}

export class Message extends Stanza {
    constructor(attrs?: any);
}

export class Presence extends Stanza {
    constructor(attrs?: any);
}

export class JID {
    local: string;
    domain: string;
    resource: string;

    constructor(local: string, domain?: string, resource?: string);

    parseJID(jid: string): void;

    toString(unescape?: any): string;

    /**
     * Convenience method to distinguish users
     */
    bare(): JID;

    /**
     * Comparison function
     */
    equals(other: JID): boolean;

    /**
     * http://xmpp.org/rfcs/rfc6122.html#addressing-localpart
     */
    setLocal(local: string, escape?: any): void;

    getLocal(unescape?: any): string;

    /**
     * http://xmpp.org/rfcs/rfc6122.html#addressing-domain
     */
    setDomain(value: string): void;

    getDomain(): string;

    /**
     * http://xmpp.org/rfcs/rfc6122.html#addressing-resourcepart
     */
    setResource(value: string): void;

    getResource(): string;
}

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/ltx, @types/node

Credits

These definitions were written by .