RxStomp


An RxJS-friendly STOMP-over-WebSocket client for the Web and Node.js.

- Guides, FAQs, and API docs: https://stomp-js.github.io/
- Samples: https://github.com/stomp-js/samples/

Introduction

This library allows you to connect to a STOMP broker over WebSocket. This library
supports complete STOMP specifications including all current protocol variants. Most
popular messaging brokers support STOMP and STOMP over WebSockets out-of-the-box
or using plugins.

This library uses https://github.com/stomp-js/stompjs under the hood.

Features

- Simple, RxJS-oriented API
- STOMP v1.2, v1.1, and v1.0
- Auto-reconnect with configurable strategies
- Browser and Node.js support
- Optional STOMP-over-TCP via custom socket factories
- Text and binary payloads
- Heartbeats and connection health hooks
- Production-friendly for long-running apps and SPAs

TypeScript definitions

The npm package includes TypeScript definitions, so there is no need to install it separately.

Usage

$3

``html






`

Notes:
- For bundlers (Vite, Webpack, Rollup), prefer installing via npm and importing from "@stomp/rx-stomp".
- The example above uses JSPM import maps for quick demos without a build step.

$3

`bash
$ npm install @stomp/rx-stomp ws
`

`javascript
import { RxStomp } from "@stomp/rx-stomp";
import { WebSocket } from 'ws';

Object.assign(global, { WebSocket });

const rxStomp = new RxStomp();
rxStomp.configure({
brokerURL: 'ws://localhost:15674/ws',
});

rxStomp.activate();

const subscription = rxStomp
.watch({ destination: "/topic/test-rx" })
.subscribe((message) => console.log(message.body));

rxStomp.publish({
destination: "/topic/test-rx",
body: "First message to RxStomp",
});

setTimeout(async () => {
subscription.unsubscribe();
await rxStomp.deactivate();
}, 3000);
`

Tips:
- Node.js does not provide a global WebSocket by default; the snippet above wires the 'ws' package into global scope for compatibility.
- If you prefer not to patch global, provide a factory:
`javascript
import { RxStomp } from "@stomp/rx-stomp";
import { WebSocket } from "ws";
const rxStomp = new RxStomp();
rxStomp.configure({
webSocketFactory: () => new WebSocket("ws://localhost:15674/ws"),
});
rxStomp.activate();
`

$3

`typescript
import { RxStomp, RxStompConfig } from "@stomp/rx-stomp";

const config: RxStompConfig = {
brokerURL: "ws://localhost:15674/ws",
reconnectDelay: 2000,
heartbeatIncoming: 10000,
heartbeatOutgoing: 10000,
};

const rxStomp = new RxStomp();
rxStomp.configure(config);
rxStomp.activate();

const sub = rxStomp.watch({ destination: "/topic/news" }).subscribe(msg => {
console.log("News:", msg.body);
});
`

Further information

See https://stomp-js.github.io/ for instructions and tutorials.

See samples at: https://github.com/stomp-js/samples/.

API documentation at:
https://stomp-js.github.io/api-docs/latest/classes/RxStomp.html.

Troubleshooting

- Connection retries: tune reconnectDelay, maxReconnectDelay, and reconnectTimeMode.
- Heartbeats: set heartbeatIncoming/heartbeatOutgoing to detect stale connections.
- Binary payloads: use binaryBody and set an appropriate content-type`.
- React Native issue: see https://stomp-js.github.io/workaround/stompjs/rx-stomp/react-native-additional-notes.html.
- SockJS issues: see https://stomp-js.github.io/guide/stompjs/rx-stomp/using-stomp-with-sockjs.html.

Change-log

Please visit Change Log.

Contributing

If you want to understand the code, develop, or contribute. Please visit
How to contribute.

Authors

- Sam Finnigan
- Jimi (Dimitris) Charalampidis
- Deepak Kumar
- Astha Deep
- Michel Promonet
- Ray Booysen
- Matt Critchlow
- Ivan
- Everyone involved at https://github.com/stomp-js/stompjs

License

License - Apache-2.0