# socket-observer

> Make an Observable from net.Socket easily

Latest version **0.1.4** (published 2019-11-12) · ISC license · 0 weekly downloads

## Install

```sh
npm install socket-observer
pnpm add socket-observer
yarn add socket-observer
bun add socket-observer
```

## 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.4 |
| Published | 2019-11-12 |
| First published | 2019-11-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vitaly Sorokin |
| Maintainers | randomnerd |
| Keywords | socket, rxjs, observer |

## Links

- npm: https://www.npmjs.com/package/socket-observer
- Repository: https://github.com/randomnerd/socket-observer
- Issues: https://github.com/randomnerd/socket-observer/issues
- npm.io page: https://npm.io/package/socket-observer

## Dependencies (2)

- [rxjs](https://npm.io/package/rxjs.md) ^6.5.3
- [debug](https://npm.io/package/debug.md) ^4.1.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.4 (latest) — 2019-11-12
- 0.1.3 — 2019-11-12
- 0.1.2 — 2019-11-12
- 0.1.1 — 2019-11-12
- 0.1.0 — 2019-11-12

## README

# socket-observer

Simple [RXJS](https://rxjs.dev/) wrapper around node's [net.Socket](https://nodejs.org/api/net.html#net_class_net_socket).

## Installation

```bash
npm install --save socket-observer
```

## Example usage

With user-provided socket:
```typescript
import { createConnection } from 'net';
import { socketObserver } from 'socket-observer';

const socket = createConnection({
    host: 'example.com',
    port: 80
});
const oSocket = socketObserver(socket);
oSocket.down.subscribe(console.log);
oSocket.up('GET / HTTP/1.1\nHost: example.com\n\n');
```

Or using `createConnection` helper:
```typescript
import { createConnection } from 'socket-observer';

const oSocket = createConnection({
    host: 'example.com',
    port: 80
});
oSocket.down.subscribe(console.log);
oSocket.up('GET / HTTP/1.1\nHost: example.com\n\n');
```

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