Package Exports

websocket-stream
websocket-stream/echo-server.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (websocket-stream) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

websocket-stream

Use HTML5 websockets using the Node Streams API. Works in Node or in Browsers.

In the browser

You can use browserify to package this module for browser use.

var websocket = require('websocket-stream')
var ws = websocket('ws://realtimecats.com')
ws.pipe(somewhereAwesome)

In the example above ws is a duplex stream. That means you can pipe output to anything that accepts streams. You can also pipe data into streams (such as a webcam feed or audio data).

On the server

Using the ws module you can make a websocket server and use this module to get websocket streams on the server:

var WebSocketServer = require('ws').Server
var websocket = require('websocket-stream')
var wss = new WebSocketServer({server: someHTTPServer})
wss.on('connection', function(ws) {
  var stream = websocket(ws)
  fs.createReadStream('bigdata.json').pipe(stream)
})

run the tests

server-side tests

npm test

client side tests

first start the echo server by running node test-server.js

then run npm start and open localhost:9966 in your browser and open the Dev Tools console to see test output

license

BSD LICENSE