# websocket-client

> An HTML5 Web Sockets client

Latest version **1.0.0** (published 2012-02-13) · 0 weekly downloads

## Install

```sh
npm install websocket-client
pnpm add websocket-client
yarn add websocket-client
bun add websocket-client
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2012-02-13 |
| First published | 2012-02-13 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.1.98 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Peter Griess |

## Links

- npm: https://www.npmjs.com/package/websocket-client
- npm.io page: https://npm.io/package/websocket-client

## Recent versions

- 1.0.0 (latest) — 2012-02-13
- 0.9.3 — 2012-02-13
- 0.9.4 — 2012-02-13
- 0.9.5 — 2012-02-13

## 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.

---
_Source: https://npm.io/package/websocket-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._