# @xmpp/iq

> XMPP iq for JavaScript

Latest version **0.14.0** (published 2025-10-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install @xmpp/iq
pnpm add @xmpp/iq
yarn add @xmpp/iq
bun add @xmpp/iq
```

## Health

**Score 58/100 (C)** — status: stable.

Positive: has types package; esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.14.0 |
| Published | 2025-10-29 |
| First published | 2018-10-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | separate (@types/xmpp__iq) |
| Module format | ESM + CommonJS |
| Node | >= 20.10 |
| Dependencies | 4 |
| Unpacked size | 15.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2275 |
| Maintainers | sonny |
| Keywords | XMPP, iq, caller, callee |

## Links

- npm: https://www.npmjs.com/package/@xmpp/iq
- Repository: https://github.com/xmppjs/xmpp.js
- Homepage: https://github.com/xmppjs/xmpp.js/tree/main/packages/iq
- Issues: http://github.com/xmppjs/xmpp.js/issues
- npm.io page: https://npm.io/package/@xmpp/iq

## Dependencies (4)

- [@xmpp/id](https://npm.io/package/@xmpp/id.md) ^0.14.0
- [@xmpp/xml](https://npm.io/package/@xmpp/xml.md) ^0.14.0
- [@xmpp/events](https://npm.io/package/@xmpp/events.md) ^0.14.0
- [@xmpp/middleware](https://npm.io/package/@xmpp/middleware.md) ^0.14.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.14.0 (latest) — 2025-10-29
- 0.13.3 — 2024-12-23
- 0.13.1 — 2022-02-13
- 0.13.0 — 2021-08-28
- 0.12.1 — 2021-08-22
- 0.12.0 — 2020-12-21
- 0.11.0 — 2020-02-14
- 0.10.0 — 2020-02-07
- 0.9.2 — 2020-01-02
- 0.9.1 — 2019-11-23
- 0.9.0 — 2019-11-19
- 0.8.0 — 2019-10-06
- 0.7.4 — 2019-06-15
- 0.7.1 — 2019-04-19
- 0.7.0 — 2019-02-03
- … 5 more at https://npm.io/package/@xmpp/iq/versions

## README

# iq

> Info/Query, or IQ, is a "request-response" mechanism, similar in some ways to the Hypertext Transfer Protocol [HTTP]. The semantics of IQ enable an entity to make a request of, and receive a response from, another entity.

[XMPP Core: IQ Semantics](https://xmpp.org/rfcs/rfc6120.html#stanzas-semantics-iq)

Included in `@xmpp/client` and `@xmpp/component`.

## Caller

Implements the caller side of iq semantics.

```js
import { client } from "@xmpp/client"; // or component

const xmpp = client(...);
const {iqCaller} = xmpp;
```

### request

Sends an iq and returns a promise.

- Resolves with the response when it is received.
- Rejects with `StanzaError` when an error is received
- Rejects with `TimeoutError` if a reply wasn't received within the specified or default timeout
- Rejects with `Error` for anything else

* The request `id` attribute is optional and will be added if omitted.
* The request `to` attribute is optional and will default to the server.

```js
const response = await iqCaller.request(
  xml("iq", { type: "get" }, xml("foo", "foo:bar")),
  30 * 1000, // 30 seconds timeout - default
);
const foo = response.getChild("foo", "foo:bar");
console.log(foo);
```

### get

A convenient method to send a `get` request. Behaves like [request](#request) but accepts/returns a child element instead of an `iq`.

```js
const foo = await iqCaller.get(
  xml("foo", "foo:bar"),
  to, // "to" attribute, optional
  timeout, // 30 seconds timeout - default
);
console.log(foo);
```

### set

A convenient method to send a `set` request. Behaves like [request](#request) but accepts/returns a child element instead of an `iq`.

```js
const foo = await iqCaller.set(
  xml("foo", "foo:bar"),
  to, // "to" attribute, optional
  timeout, // 30 seconds timeout - default
);
console.log(foo);
```

## Callee

Implements the callee side of iq semantics.

You can think of this as http routing except there are only 2 methods; `get` and `set` and you would pass a namespace and a tag name instead of an url. The return value of the handler will be the child element of the response sent to the caller.

```js
import { client } from "@xmpp/client"; // or component

const xmpp = client(...);
const {iqCallee} = xmpp;
```

## get

Add a `get` handler.

```js
iqCallee.get("foo:bar", "foo", (ctx) => {
  return xml("foo", { xmlns: "foo:bar" });
});
```

## set

Add a `set` handler.

```js
iqCallee.set("foo:bar", "foo", (ctx) => {
  return xml("foo", { xmlns: "foo:bar" });
});
```

## References

[RFC 6120 IQ Semantics](https://xmpp.org/rfcs/rfc6120.html#stanzas-semantics-iq)

---
_Source: https://npm.io/package/@xmpp/iq · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._