https://github.com/pgriess/node-websocket-client

A Web Socket client for NodeJS
https://github.com/pgriess/node-websocket-client

Last synced: 13 days ago
JSON representation

A Web Socket client for NodeJS

• Host: GitHub
• URL: https://github.com/pgriess/node-websocket-client
• Owner: pgriess
• License: bsd-3-clause
• Archived: true
• Created: 2010-06-10T17:23:46.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2019-08-20T13:41:20.000Z (about 5 years ago)
• Last Synced: 2024-08-01T16:35:34.748Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 672 KB
• Stars: 150
• Watchers: 10
• Forks: 68
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
A prototype [Web Socket](http://www.whatwg.org/specs/web-socket-protocol/)

client implementation for [node.js](http://nodejs.org).

Tested with

[miksago/node-websocket-server](http://github.com/miksago/node-websocket-server)

v1.2.00.

Requires [nodejs](http://nodejs.org) 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.