This module works in Node or in Browsers that support WebSockets. You can use browserify to package this module for browser use.
var websocket = require('websocket-stream')var ws = websocket('ws://echo.websocket.org')process.stdin.pipe(ws)ws.pipe(process.stdout)
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).
The underlying WebSocket instance is available as ws.socket.
Options
The available options differs depending on if you use this module in the browser or with node.js. Options can be passed in as the third or second argument - WebSocket(address, [protocols], [options]).
options.browserBufferSize
How much to allow the socket.bufferedAmount to grow before starting to throttle writes. This option has no effect in node.js.
Default: 1024 * 512 (512KiB)
options.browserBufferTimeout
How long to wait before checking if the socket buffer has drained sufficently for another write. This option has no effect in node.js.
Default: 1000 (1 second)
options.objectMode
Send each chunk on its own, and do not try to pack them in a single
websocket frame.
Default: false
options.binary
Always convert to Buffer in Node.js before sending.
Forces options.objectMode to false.
Using the ws module you can make a websocket server and use this module to get websocket streams on the server:
var websocket = require('websocket-stream')var wss = websocket.createServer({server: someHTTPServer}, handle)function handle(stream, request) { // `request` is the upgrade request sent by the client. fs.createReadStream('bigdata.json').pipe(stream)}