xmpp-httpx - v0.11.0
    Preparing search index...

    Interface HttpxClientOptions

    interface HttpxClientOptions {
        accept?: { ibb?: boolean; jingle?: boolean; sipub?: boolean };
        compress?: boolean;
        defaultTimeoutMs?: number;
        discover?: boolean;
        from?: string;
        ibbBlockSize?: number;
        ibbSessionWindow?: number;
        ibbWindow?: number;
        idleTimeoutMs?: number;
        inlineBudgetBytes?: number;
        maxBufferedBytes?: number;
        maxChunkSize?: number;
        preferredStreams?: readonly StreamMechanism[];
        socks5?: Socks5Adapter;
    }
    Index
    accept?: { ibb?: boolean; jingle?: boolean; sipub?: boolean }

    Response-body mechanisms to advertise; all default to true.

    compress?: boolean

    Advertise Accept-Encoding: gzip, deflate (responses are transparently decompressed either way). Default true.

    defaultTimeoutMs?: number

    IQ timeout; also bounds streamed request-body transfer. Default 60 s.

    discover?: boolean

    Check the peer for urn:xmpp:http via disco#info first. Default true.

    from?: string

    Explicit sender JID — required when the session is a component.

    ibbBlockSize?: number

    Decoded bytes per IBB block for request bodies. XEP-0332 gives the responder no way to advertise a limit for those, so unlike the response direction — where maxChunkSize above tells the server what this client can receive — there is nothing to negotiate with and this is simply the size used. Default 4096. Derive it with stanzaBudgets(maxStanzaBytes), against the responder's limit.

    ibbSessionWindow?: number

    IBB blocks in flight across every stream on this session together — the fair scheduler's budget. Default 16. When it is full, freed slots go to waiting streams in turn, so one large transfer cannot starve the rest. Per session: shared with anything else using IBB on it.

    ibbWindow?: number

    IBB blocks kept in flight when streaming a request body, and the number an inbound response body may run ahead before acks are withheld. Default 8. One block costs a round trip, so this is the multiplier on a high-latency path; 1 restores the block-at-a-time sender. The session budget (ibbSessionWindow) caps it.

    idleTimeoutMs?: number

    Idle timeout for streamed response bodies.

    inlineBudgetBytes?: number

    Inline budget for request bodies (encoded bytes).

    maxBufferedBytes?: number

    Cap on buffered out-of-order response chunks.

    maxChunkSize?: number

    Advertised in for chunked responses.

    preferredStreams?: readonly StreamMechanism[]

    Mechanism preference for streamed request bodies.

    socks5?: Socks5Adapter

    Enables XEP-0065 SOCKS5 Bytestreams as a sipub stream-method alongside IBB (Node-only — see xmpp-httpx/node's createSocks5Adapter).