https://github.com/stomp-js/stompjs
Javascript and Typescript Stomp client for Web browsers and node.js apps
https://github.com/stomp-js/stompjs
messaging rabbitmq stomp stompclient stompjs websocket
Last synced: 2 months ago
JSON representation
Javascript and Typescript Stomp client for Web browsers and node.js apps
- Host: GitHub
- URL: https://github.com/stomp-js/stompjs
- Owner: stomp-js
- License: apache-2.0
- Created: 2018-05-25T12:08:54.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2023-11-08T20:03:55.000Z (over 2 years ago)
- Last Synced: 2024-04-14T06:17:18.651Z (almost 2 years ago)
- Topics: messaging, rabbitmq, stomp, stompclient, stompjs, websocket
- Language: TypeScript
- Homepage:
- Size: 4.36 MB
- Stars: 710
- Watchers: 16
- Forks: 79
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Changelog: Change-log.md
- License: LICENSE
Awesome Lists containing this project
README
# STOMP.js
[](https://github.com/stomp-js/stompjs/actions/workflows/linux.yml)
[](https://github.com/stomp-js/stompjs/actions/workflows/osx.yml)
[](https://github.com/stomp-js/stompjs/actions/workflows/node-js.yml)
[](https://github.com/stomp-js/stompjs/actions/workflows/docs-refresh.yml)
**STOMP.js** is a fully-fledged STOMP over WebSocket library for **browsers** and **Node.js**, providing seamless integration with STOMP protocol-compliant messaging brokers.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Getting Started](#getting-started)
- [Browser](#browser)
- [Node.js](#nodejs)
- [Documentation](#documentation)
- [Upgrading](#upgrading)
- [Usage with RxJS](#usage-with-rxjs)
- [TypeScript Support](#typescript-support)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Authors](#authors)
- [License](#license)
## Introduction
This library enables clients to connect to STOMP brokers over WebSocket (or TCP). It fully implements the STOMP protocol specifications (v1.0, v1.1, and v1.2), making it compatible with any broker that supports STOMP or STOMP over WebSocket.
Popular brokers like RabbitMQ, ActiveMQ, and others provide support for STOMP and STOMP over WebSockets out-of-the-box.
## Features
- Simple and intuitive API for interacting with the STOMP protocol
- Support for STOMP protocol versions: **1.2**, **1.1**, and **1.0**
- Support for fallback options when WebSocket is unavailable
- Supports both **browser** and **Node.js** environments
- Option to connect using **STOMP over TCP**
- Full support for **binary payloads**
- Compatible with RxJS for reactive programming
## Getting Started
This section provides a quick guide to integrating STOMP.js into your **browser** or **Node.js** application.
### Browser
To use STOMP.js in a browser:
1. Add the following in your HTML file:
```html
{
"imports": {
"@stomp/stompjs": "https://ga.jspm.io/npm:@stomp/stompjs@7.0.0/esm6/index.js"
}
}
```
2. Use the library:
```javascript
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();
```
### Node.js
To use STOMP.js in a Node.js environment:
1. Install the package:
```bash
npm install @stomp/stompjs ws
```
2. Use it in your application:
```javascript
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();
```
---
## Documentation
Comprehensive documentation can be found at: [STOMP.js Documentation](https://stomp-js.github.io/)
- **API Overview**: [API Docs (latest)](https://stomp-js.github.io/api-docs/latest/)
- **Usage Guide**: [Guide to Using STOMP.js](https://stomp-js.github.io/guide/stompjs/using-stompjs-v5.html)
- **Feature Guides**: Explore additional guides at [https://stomp-js.github.io/](https://stomp-js.github.io/)
## Upgrading
If you are updating from an older version of STOMP.js, review the [Upgrading Guide](https://stomp-js.github.io/#upgrading) for any required changes.
## Usage with RxJS
[Rx-Stomp](https://github.com/stomp-js/rx-stomp) builds upon this library, exposing all its features as **RxJS Observables**, enabling reactive programming patterns.
## TypeScript Support
STOMP.js includes built-in TypeScript definitions, eliminating the need for external type definition files. Begin coding with TypeScript out-of-the-box!
## Changelog
Visit the [Change Log](Change-log.md) for information about changes, improvements, and fixes in recent releases.
## Contributing
Thinking of contributing to STOMP.js? Great! To get started:
- Read the [Contributing Guide](Contribute.md) for development instructions.
- Report bugs or suggest features by creating an issue on GitHub.
We welcome contributions from the community!
## Authors
This library is made possible by these amazing contributors:
- [Deepak Kumar](https://github.com/kum-deepak)
- [Astha Deep](https://github.com/astha183)
- [Dillon Sellars](https://github.com/dillon-sellars)
- [Jimi Charalampidis](https://github.com/jimic)
- [Raul](https://github.com/rulonder)
- [Dimitar Georgiev](https://github.com/iMitaka)
- [Genadi](https://github.com/genadis)
- [Bobohuochai](https://github.com/bobohuochai)
- [Sailai](https://github.com/sailai)
- [Harsh Deep](https://github.com/harsh183)
- [Nikos Epping](https://github.com/Nikos410)
- [Tom Pachtner](https://github.com/tomamatics)
- [David Nussio](https://github.com/davidnussio)
- [Camille Drapier](https://github.com/CamilleDrapier)
- [chai min](https://github.com/minchai23)
- [umsungjun](https://github.com/umsungjun)
- [tomek3e](https://github.com/tomek3e)
- [Samuel Yinger](https://github.com/GoldenSunX)
- [RokkieBrown](https://github.com/rokkie)
- [Alexey](https://github.com/Al-ex-ei)
This library is originally based on [stompjs](https://github.com/jmesnil/stomp-websocket) by [Jeff Mesnil](http://jmesnil.net/) with enhancements and bug fixes from [Jeff Lindsay](http://github.com/progrium) and [Vanessa Williams](http://github.com/fridgebuzz).
## License
Licensed under the **Apache-2.0 License**. See the [LICENSE file](LICENSE) for details.