Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

stompjs-websocket

4.1.7 • Public • Published

STOMP.js

Build Status

This library provides a WebSocket over STOMP client for Web browser or node.js applications.

Important

This repository has code for version 3.x.x./4.x.x. Version 5.x.x onwards is being maintained at https://github.com/stomp-js/stompjs

Only security updates will be carried out in 4.x.x series. Please consider upgrading to 5.0.0 (https://stomp-js.github.io/stompjs/additional-documentation/upgrading.html)

Introduction

This library allows you to connect to a STOMP broker over WebSocket. This library supports full STOMP specifications and all current protocol variants. Most popular messaging brokers support STOMP and STOMP over WebSockets either natively or using plugins.

In general JavaScript engines in browsers are not friendly to binary protocols, so using STOMP is a better option because it is a text oriented protocol.

This library was originally developed by Jeff Mesnil.

Current Status

This library is feature complete and has been used in production for many years. It is actively maintained. You are welcome to file issues and submit pull requests.

Getting started

The documentation is hosted as GitHub pages. You may head straight to the entry point. (or with frames)

This library comes with detailed usage instructions. Please find it at Usage instructions.

If you were using older versions and wish to benefit from newer features, head to Upgrading.

If you are an existing user and will like to deep dive - API references for important entities:

NodeJS

If you are using this library in NodeJS you might need to make changes, please check Upgrading.

Usage with Angular2/4/5

https://github.com/stomp-js/ng2-stompjs is based on this library and exposes the entire functionality offered by this library as Angular Services and rxjs Observables. Both these libraries are maintained by a similar set of contributors.

TypeScript definitions

The npm package includes TypeScript definitions, so there is no need no 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.

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

Authors

License

License - Apache v2 License

Install

npm i stompjs-websocket

DownloadsWeekly Downloads

51

Version

4.1.7

License

Apache-2.0

Unpacked Size

746 kB

Total Files

66

Last publish

Collaborators

  • avatar