# wspipe

> web socket to tcp service pipe library

Latest version **0.1.0** (published 2015-02-04) · 0 weekly downloads

## Install

```sh
npm install wspipe
pnpm add wspipe
yarn add wspipe
bun add wspipe
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-02-04 |
| First published | 2015-01-31 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | el aras |
| Maintainers | openmason |
| Keywords | websocket, tcp, proxy |

## Links

- npm: https://www.npmjs.com/package/wspipe
- Repository: https://github.com/openmason/wspipe
- Issues: https://github.com/openmason/wspipe/issues
- npm.io page: https://npm.io/package/wspipe

## Dependencies (1)

- [ws](https://npm.io/package/ws.md) >= 0.7.1

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2015-02-04
- 0.0.2 — 2015-02-01
- 0.0.1 — 2015-01-31

## README

[![build status](https://secure.travis-ci.org/openmason/wspipe.png)](http://travis-ci.org/openmason/wspipe)
# WebSocket to TCP pipe (wspipe)
Connects WebSocket and TCP (bridge TCP socket over WS).

# Usage
First create a WebSocket Server connection

    var WebSocketServer = require('ws').Server;
    var server = new WebSocketServer({port:80, path:'/mysocket'});

Let wspipe bridge the WS to TCP
  
    var WebSocketPipe = require('wspipe');
    var debug = true;
    var tcpServerHost = 'localhost';
    var tcpServerPort = 3474;
    var wspipe = new WebSocketPipe(server, debug, tcpServerHost, tcpServerPort);
    // thats' it ... all new connections to ws are automatically taken care of


# Examples

## MQTT over WebSocket
To do a MQTT client/WS to WS <--> MQTT Broker, please refer to examples/ws-mqtt.js

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