cycle-socket.io-server
cycle-socket.io-server is a socket.io server driver for cycle.js
Installation
npm i cycle-socket.io-server --save
Import
const makeSocketIOServerDriver = ;
Use
makeSocketIOServerDriver(io)
Create the driver : With io
the socket.io instance
const drivers = // create a socket.io server driver instance socketServer: ;
socketServer.connect()
Get users connections with Return the stream of users connections
{ const socketServer = sources; // get user connection stream ( A sockets stream ) const connection$ = socketServer; // socket is a socket.io socket wrapper const events$ = connection$ }
Socket wrapper API
Currently, the socket has only one function.
socket.events()
Listener socket events with Return a stream a events objects {name:<string>, data:*}
emit by the socket.
const events$ = connection$;
Send a socket event
Send stream of object on the sink socketServer
The object definition
socket:socket // the target socket name:'ping' // the event name:<string> data: 'pong' // the event data
A ping example
// send a ping message to a specific soket every second. const ping$ = xs; const sinks = socketServer: ping$ ;
A full example
const xs = default run = makeSocketIOServerDriver = ; const io = ; { const socketServer = sources; // get user connection stream const connection$ = socketServer; const events$ = connection$; // send a ping message to a specific soket every second. const ping$ = xs; const sinks = socketServer: ping$ fake: events$ ; return sinks; } const drivers = // create a socket.io server driver instance socketServer: // a fake driver who listen socket events stream fake: ; ;}