Overview

This package is a simple, reliable, isomorphic, two-way WebSocket client built with RxJS 6. It provides these advantages:

It integrates nicely with RxJS observables.
Push and pull messages to and from a remote WebSocket server.
It is compatible with node.js, unlike the RxJS's WebSocket object.
The WebSocket Observable created by this package emits multiple types of events including messages, connection status changes and the websocket itself. It provides operators to pull and publish whichever data is needed.
The package uses sensible conventions and handles most connectivity interruptions and issues. But it also gives the user fine-grained control over how to handle different events.
Uses socket.io under the hood, which is battle-tested, widely used, well maintained and reliable.
Requires the use of secure WSS unless the user explicitly indicates otherwise.
Easily integrates with React/Redux, Vue, Angular and other popular front-ends.

npm i @buccaneer/rxws --save

yarn add @buccaneer/rxws

Platform

Support

node.js (>10.8)

✅

Browsers

✅

React Native

✅

Electron

✅

Do you like rxws? Here's how you can help make it better:

MIT

Last updated 5 years ago