Package Exports
- websocket-client
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-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
A prototype Web Socket client implementation for node.js.
Tested with miksago/node-websocket-server v1.2.00.
Requires nodejs 0.1.98 or later.
Installation
Install this using npm as follows
npm install websocket-client... or just dump lib/websocket.js in your $NODE_PATH.
Usage
var sys = require('sys');
var WebSocket = require('websocket').WebSocket;
var ws = new WebSocket('ws://localhost:8000/biff', 'borf');
ws.addListener('data', function(buf) {
sys.debug('Got data: ' + sys.inspect(buf));
});
ws.onmessage = function(m) {
sys.debug('Got message: ' + m);
}API
This supports the send() and onmessage() APIs. The WebSocket object will
also emit data events that are node Buffer objects, in case you want to
work with something lower-level than strings.
Transports
Multiple transports are supported, indicated by the scheme provided to the
WebSocket constructor. ws:// is a standard TCP-based Web Socket;
ws+unix:// allows connection to a UNIX socket at the given path.