edgeport - v1.0.6
    Preparing search index...

    Interface XmppConnectOptions

    Options for connect.

    1.0.4

    interface XmppConnectOptions {
        domain?: string;
        hostname?: string;
        jid: string;
        keepAliveSeconds?: number;
        mechanisms?: "PLAIN" | ScramMechanism | ("PLAIN" | ScramMechanism)[];
        password: string;
        port?: number;
        resource?: string;
        scheduler?: XmppScheduler;
        timeoutMs?: number;
        tls?: "off" | "starttls" | "implicit";
    }
    Index
    domain? hostname? jid keepAliveSeconds? mechanisms? password port? resource? scheduler? timeoutMs? tls?
    domain?: string

    XMPP domain (the to of the stream); defaults to the JID domain.

    hostname?: string

    Remote host to dial; defaults to the JID domain.

    jid: string

    Bare JID user@domain to authenticate as.

    keepAliveSeconds?: number

    Whitespace keep-alive interval in seconds; disabled when omitted or 0.

    mechanisms?: "PLAIN" | ScramMechanism | ("PLAIN" | ScramMechanism)[]

    Forced SASL mechanism order; the first that the server offers is used.

    password: string

    Account password.

    port?: number

    Remote port; defaults to 5222 (plaintext/STARTTLS) or 5223 (tls: 'implicit').

    resource?: string

    Requested resource; the server may reassign it. A random one is requested when omitted.

    scheduler?: XmppScheduler

    Timer override for the keep-alive (mainly for testing).

    timeoutMs?: number

    Per-step read deadline in milliseconds for the connect handshake.

    tls?: "off" | "starttls" | "implicit"

    Transport security:

    • 'off': plaintext, no STARTTLS.
    • 'starttls' (default): plaintext, upgraded via STARTTLS when the server offers it.
    • 'implicit': TLS from the first byte (legacy port 5223).

    Settings
    Member Visibility

    On This Page
    Properties