https://github.com/rxtoolkit/socketio

🚰 RxJS operators for working with Socket.io (v4 or lower) servers
https://github.com/rxtoolkit/socketio

fp functional-programming observables package reactive-programming realtime rxjs socket-io socketio streaming websocket websockets

Last synced: about 1 month ago
JSON representation

🚰 RxJS operators for working with Socket.io (v4 or lower) servers

• Host: GitHub
• URL: https://github.com/rxtoolkit/socketio
• Owner: rxtoolkit
• License: mit
• Created: 2021-10-21T14:17:22.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-02-16T18:40:05.000Z (9 months ago)
• Last Synced: 2024-09-29T01:03:18.764Z (about 2 months ago)
• Topics: fp, functional-programming, observables, package, reactive-programming, realtime, rxjs, socket-io, socketio, streaming, websocket, websockets
• Language: JavaScript
• Homepage:
• Size: 667 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# @rxtk/socketio

> 🚰 Hooks for RxJS Observables to interface with Socket.io (v4) servers

```bash

npm i @rxtk/socketio

```

```bash

yarn add @rxtk/socketio

```

## Compatability

| Platform | Support |

| :--- | :--- |

| node.js \(>10.0\) | ✅ |

| Browsers | ✅ |

| React Native | ✅ |

| Electron | ✅ |

## API

### `conduit()`

Opens a two-way channel of communication with the server.  Items sent into

the operator will be sent to the server.  By default, the output stream is the messages

sent back from the server.

```js

import {from} from 'rxjs';

import {conduit} from '@rxtk/socketio';

const messageIn$ = from([

  {topic: 'message', body: 'yarrr'},

  {topic: 'message', body: 'arrr matey'},

  {topic: 'message', body: 'Vitamin C? Never heard of it.'},

  {topic: 'message', body: 'Why is all the rum gone?'},

]);

const socketConfig = {

  url: 'http://localhost:9080/ws', // socket.io server

  topics: ['message'], // topics to subscribe to. (Defaults to ['message']).

  // the socket options get passed directly to the Socket.io instance, allowing

  // any customization that the socket.io client supports.

  socketOptions: {

    transports: ['websocket'],

    auth: {token: 'secretjwttoken'},

  },

}; 

// the conduit operator sends messages from messageIn$ and emits messages 

// from the server

const messageBack$ = messageIn$.pipe(conduit({...socketConfig}));

messageBack$.subscribe(console.log);

messageBack$.error$.subscribe(console.error); // optional: handle errors

// {topic: 'message', body: 'Welcome Matey.'}

// {topic: 'message', body: 'Yo ho. Yo ho. I am a message from the server.'}

```

You can also send binary data:

```js

import {from} from 'rxjs';

import {conduit} from '@rxtk/socketio';

const messageIn$ = from([

  {topic: 'next-audio-chunk', index: 0, binary: Buffer.from('foobar', 'base64')},

  {topic: 'next-audio-chunk', index: 1, binary: Buffer.from('foobar', 'base64')},

]);

const socketConfig = {

  url: 'http://localhost:9080/ws',

  topics: ['message', 'audio-received'],

};

messageIn$.pipe(conduit({...socketConfig}));

// {topic: 'audio-received', index: 0}

// {topic: 'audio-received', index: 1}

```

## Advanced configuration

The library also supports some advanced features commonly needed in real applications:

- sending binary

- verifying receipt of messages before sending the next

- customizing the socket.io client

- adding serializers/deserializers

- handling disconnections

See the the code (`src/operators/conduit`) for advanced configuration options.  This is a pretty lightweight wrapper and the code should be pretty easy to read and understand.