RxStomp

This library provides an RxJS oriented STOMP over WebSocket client for Web browser and node.js applications.

Please visit https://stomp-js.github.io/ for guides, FAQs and API docs.

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 API to interact with the Stomp protocol
• Support for v1.2, v1.1 and v1.0 of the Stomp protocol
• Support for fallback options in case of WebSocket unavailable
• Browser and Node.js support
• Option to use STOMP over TCP
• Binary payload support
• Suitable for usage with long-running applications, pages, and SPAs.

TypeScript definitions

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

Usage

Browser

1<script type="importmap">
2  {
3    "imports": {
4      "@stomp/rx-stomp": "https://ga.jspm.io/npm:@stomp/rx-stomp@2.0.0/esm6/index.js"
5    },
6    "scopes": {
7      "https://ga.jspm.io/": {
8        "@stomp/stompjs": "https://ga.jspm.io/npm:@stomp/stompjs@7.0.0/esm6/index.js",
9        "rxjs": "https://ga.jspm.io/npm:rxjs@7.8.0/dist/esm5/index.js",
10        "tslib": "https://ga.jspm.io/npm:tslib@2.5.0/modules/index.js",
11        "uuid": "https://ga.jspm.io/npm:uuid@9.0.0/dist/esm-browser/index.js"
12      }
13    }
14  }
15  </script>
16
17<!-- ES Module Shims: Import maps polyfill for modules browsers without import maps support (all except Chrome 89+) -->
18<script async src="https://ga.jspm.io/npm:es-module-shims@1.5.1/dist/es-module-shims.js" crossorigin="anonymous"></script>
19
20<script type="module">
21  import { RxStomp } from "@stomp/rx-stomp";
22
23  const rxStomp = new RxStomp();
24  rxStomp.configure({
25    brokerURL: 'ws://localhost:15674/ws',
26  });
27
28  rxStomp.activate();
29
30  const subscription = rxStomp
31    .watch({ destination: "/topic/test-rx" })
32    .subscribe((message) => console.log(message.body));
33
34  rxStomp.publish({
35    destination: "/topic/test-rx",
36    body: "First message to RxStomp",
37  });
38
39  setTimeout(async () => {
40    subscription.unsubscribe();
41    await rxStomp.deactivate();
42  }, 3000);
43</script>

NodeJS

1$ npm install @stomp/rx-stomp ws

1import { RxStomp } from "@stomp/rx-stomp";
2import { WebSocket } from 'ws';
3
4Object.assign(global, { WebSocket});
5
6const rxStomp = new RxStomp();
7rxStomp.configure({
8  brokerURL: 'ws://localhost:15674/ws',
9});
10
11rxStomp.activate();
12
13const subscription = rxStomp
14  .watch({ destination: "/topic/test-rx" })
15  .subscribe((message) => console.log(message.body));
16
17rxStomp.publish({
18  destination: "/topic/test-rx",
19  body: "First message to RxStomp",
20});
21
22setTimeout(async () => {
23  subscription.unsubscribe();
24  await rxStomp.deactivate();
25}, 3000);

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.

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
• Everyone involved at https://github.com/stomp-js/stompjs

License

License - Apache-2.0