@stomp/stompjs

What is @stomp/stompjs?

@stomp/stompjs is a JavaScript library that provides a STOMP (Simple Text Oriented Messaging Protocol) client for WebSocket communication. It allows you to connect to a STOMP broker over WebSocket, send and receive messages, and handle various messaging scenarios in real-time applications.

What are @stomp/stompjs's main functionalities?

Connect to a STOMP broker

This feature allows you to connect to a STOMP broker using WebSocket. You can specify the broker URL, connection headers, and callback functions for connection success and error handling.

const Stomp = require('@stomp/stompjs');
const client = new Stomp.Client({
  brokerURL: 'ws://localhost:8080/stomp',
  connectHeaders: {
    login: 'user',
    passcode: 'password'
  },
  onConnect: () => {
    console.log('Connected to the broker');
  },
  onStompError: (frame) => {
    console.error('Broker reported error: ' + frame.headers['message']);
    console.error('Additional details: ' + frame.body);
  }
});
client.activate();

Subscribe to a topic

This feature allows you to subscribe to a specific topic on the STOMP broker. When a message is sent to that topic, the provided callback function is executed, and the message is processed.

client.onConnect = () => {
  client.subscribe('/topic/messages', (message) => {
    console.log('Received message: ' + message.body);
  });
};

Send a message

This feature allows you to send a message to a specific destination (topic or queue) on the STOMP broker. The message body can be any string.

client.onConnect = () => {
  client.publish({
    destination: '/topic/messages',
    body: 'Hello, world!'
  });
};

Handle disconnection

This feature allows you to handle disconnection from the STOMP broker. You can specify a callback function to execute when the client disconnects, and you can also deactivate the client.

client.onDisconnect = () => {
  console.log('Disconnected from the broker');
};
client.deactivate();

Other packages similar to @stomp/stompjs

sockjs-client

sockjs-client is a JavaScript library that provides a WebSocket-like object for browsers. It is designed to work with the SockJS server, which provides a WebSocket emulation layer. Unlike @stomp/stompjs, which is specifically for STOMP protocol, sockjs-client focuses on providing a WebSocket-like API with fallback options for older browsers.

webstomp-client

webstomp-client is a STOMP client for WebSocket in JavaScript. It is similar to @stomp/stompjs in that it provides STOMP protocol support over WebSocket. However, webstomp-client is a simpler and smaller library, which might be suitable for projects that require a lightweight STOMP client.

rhea

rhea is a JavaScript library for messaging using the AMQP protocol. While it is not a STOMP client, it provides similar messaging capabilities over WebSocket and other transports. It is more versatile in terms of protocol support compared to @stomp/stompjs, which is focused solely on STOMP.

README

STOMP.js

This library provides a 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.

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

Usage

Browser

<!--
    JSPM Generator Import Map
    Edit URL: https://generator.jspm.io/#U2NgYGBkDM0rySzJSU1hcCguyc8t0AeTWcUO5noGega6SakliaYAYTzJAykA
  -->
<script type="importmap">
  {
    "imports": {
      "@stomp/stompjs": "https://ga.jspm.io/npm:@stomp/stompjs@7.0.0/esm6/index.js"
    }
  }
</script>

<!-- ES Module Shims: Import maps polyfill for modules browsers without import maps support (all except Chrome 89+) -->
<script
  async
  src="https://ga.jspm.io/npm:es-module-shims@1.5.1/dist/es-module-shims.js"
  crossorigin="anonymous"
></script>

<script type="module">
  import { Client } from '@stomp/stompjs';

  const client = new Client({
    brokerURL: 'ws://localhost:15674/ws',
    onConnect: () => {
      client.subscribe('/topic/test01', message =>
        console.log(`Received: ${message.body}`)
      );
      client.publish({ destination: '/topic/test01', body: 'First Message' });
    },
  });

  client.activate();
</script>

NodeJS

$ npm install @stomp/stompjs ws

import { Client } from '@stomp/stompjs';

import { WebSocket } from 'ws';
Object.assign(global, { WebSocket });

const client = new Client({
  brokerURL: 'ws://localhost:15674/ws',
  onConnect: () => {
    client.subscribe('/topic/test01', message =>
      console.log(`Received: ${message.body}`)
    );
    client.publish({ destination: '/topic/test01', body: 'First Message' });
  },
});

client.activate();

Further information

The API documentation is hosted as GitHub pages for the StompJS family of libraries. You may head straight to the https://stomp-js.github.io/api-docs/latest/

This library comes with detailed usage instructions. Please find it at Usage instructions. Check out other guides at https://stomp-js.github.io/.

There is quite detailed API documentation, you should start at https://stomp-js.github.io/api-docs/latest/classes/Client.html.

Upgrading

if you were using an older version of this library, you would need to make changes to your code. Head to Upgrading.

Usage with RxJS

https://github.com/stomp-js/rx-stomp is based on this library and exposes the entire functionality offered by this library as RxJS Observables.

TypeScript definitions

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

Change-log

Please visit Change Log.

Contributing

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

Authors

• Jeff Mesnil
• Jeff Lindsay
• Vanessa Williams
• Deepak Kumar
• Astha Deep
• Dillon Sellars
• Jimi Charalampidis
• Raul
• Dimitar Georgiev
• Genadi
• Bobohuochai
• Sailai

License

License - Apache-2.0