# rl-socket-client

> the readline socket client

Latest version **0.1.8** (published 2015-02-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install rl-socket-client
pnpm add rl-socket-client
yarn add rl-socket-client
bun add rl-socket-client
```

## 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.8 |
| Published | 2015-02-25 |
| First published | 2015-02-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Ant Cosentino |
| Maintainers | skibz |
| Keywords | net, net.Socket, socket, readline, rocketlauncher, tty, prompt |

## Links

- npm: https://www.npmjs.com/package/rl-socket-client
- Repository: https://github.com/io-digital/rl-socket-client
- Issues: https://github.com/io-digital/rl-socket-client/issues
- npm.io page: https://npm.io/package/rl-socket-client

## 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.8 (latest) — 2015-02-25
- 0.1.7 — 2015-02-25
- 0.1.6 — 2015-02-25
- 0.1.5 — 2015-02-25
- 0.1.4 — 2015-02-25
- 0.1.0 — 2015-02-25
- 0.0.6 — 2015-02-25
- 0.0.5 — 2015-02-25
- 0.0.4 — 2015-02-25
- 0.0.3 — 2015-02-25
- 0.0.2 — 2015-02-25

## README

## rl-socket-client: the readline socket client

[![Build Status](https://travis-ci.org/io-digital/rl-socket-client.svg)](https://travis-ci.org/io-digital/rl-socket-client)
[![Coverage Status](https://coveralls.io/repos/io-digital/rl-socket-client/badge.svg)](https://coveralls.io/r/io-digital/rl-socket-client)
[![NPM](https://nodei.co/npm/rl-socket-client.png?mini=true)](https://nodei.co/npm/rl-socket-client/)

we ought to just pretend it stands for [rocketlauncher](http://ioquake3.org/wp/wp-content/themes/ioq3-deboy/explodedView.png)-socket-client. that's way cooler, right?

this module was designed for apps that require a basic tty interface for socket programs - a tcp chat client, for instance. it affords tab-completion and a simple api.

#### api

- `#connect()`: initiate a connection to the given `host` and `port`
- `#on(event)`: currently the only event emitted is `connected`
- `#write(text)`: programmatically send `text` over the wire

#### usage

```js
var rlsc = require('rl-socket-client');

new rlsc({
    host: '192.168.128.100',
    port: 1829,
    prompt: '% ',
    lineEnding: '\n',
    connect: true,
    completions: ['ls', 'pwd', 'cat', 'echo']
});

// or

var client = new rlsc({
    host: '192.168.128.100',
    port: 1829
}).connect();

client.on('connected', function() {
    client.write('blah blah...');
});
```

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