rx-socket.io-client v1.1.1

rx-socket.io-client

Easy to use rxjs powered wrapper for socket.io-client.

Although current API is experimental and limited, there won't be any breaking release without major release

Install

npm install --save rx-socket.io-client

Requires socket.io-client and rxjs as peerDependency, incase you don't have them also run:

npm install --save socket.io-client rxjs

Use

import { RxSocket } from 'rx-socket.io-client';


const socket = new RxSocket('/url/to/socket.io/server'); // javascript 

const event$ = socket.subject('event_name'); // get rxjs/Subject for a specific event

event$.subscribe((data) => { // read data
  console.log(data.foo)
});

event$.next({foo: 'bar'}); // send data

// create observables for events that you want to only listen (receive data)
const event$ = socket.observable('event_name'); // get rxjs/Observable for a specific event

event$.subscribe((data) => { // read data
  console.log(data.foo)
});

Generics

If you are using typescript, it's best to use generic types

// all observables and subject that are generated will emit/subscribe an object with string `foo` property
const socket = new RxSocket<{ foo: strig }>('/url/to/socket.io/server');

// unless type is given to the class methods when they are called.
// like below:
socket.subject<string>('event_name');
socket.observable<object>('event_name');

See tests for more detailed and up to date examples