# socket-jet

> Minimalist package for data packets over socket connections.

Latest version **0.2.24** (published 2021-12-01) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.24 |
| Published | 2021-12-01 |
| First published | 2017-09-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 55.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | vilicvane |
| Maintainers | vilic |

## Links

- npm: https://www.npmjs.com/package/socket-jet
- Repository: https://github.com/vilic/socket-jet
- Homepage: https://github.com/vilic/socket-jet#readme
- Issues: https://github.com/vilic/socket-jet/issues
- npm.io page: https://npm.io/package/socket-jet

## Dependencies (1)

- [bson](https://npm.io/package/bson.md) ^4.0.4

## Recent versions

- 0.2.24 (latest) — 2021-12-01
- 0.2.23 — 2021-11-30
- 0.2.22 — 2021-11-30
- 0.2.21 — 2021-11-30
- 0.2.20 — 2021-11-30
- 0.2.19 — 2021-11-30
- 0.2.18 — 2021-11-30
- 0.2.17 — 2021-11-29
- 0.2.16 — 2021-11-29
- 0.2.15 — 2021-11-29
- 0.2.14 — 2021-11-28
- 0.2.13 — 2021-11-27
- 0.2.12 — 2021-11-27
- 0.2.11 — 2021-11-27
- 0.2.10 — 2021-11-27
- … 12 more at https://npm.io/package/socket-jet/versions

## README

[![NPM Package](https://badge.fury.io/js/socket-jet.svg)](https://www.npmjs.com/package/socket-jet)
[![Build Status](https://travis-ci.org/vilic/socket-jet.svg)](https://travis-ci.org/vilic/socket-jet)

# Socket Jet

Minimalist package for data packets over socket connections.

## Features

### Implemented

- `Jet#send()` returns a promise that will wait for ack.
- `PowerJet#call()` to call methods defined on a remote `PowerJet`.
- Encryption support based on Node.js `Cipher` and `Decipher`.

## Installation

```sh
yarn add socket-jet
# or
npm install socket-jet --save
```

## Usage

### Basic Jet

**Server**

```ts
let server = Net.createServer(socket => {
  let jet = new Jet(socket);

  jet.on('data', data => {
    console.log(data); // {thank: 'you'} from client.
  });

  jet.send('hello').then(
    () => console.log('"hello" sent'),
    error => console.error(error),
  );
});

server.listen(10047);
```

**Client**

```ts
let socket = Net.connect(10047, () => {
  let jet = new Jet(socket);

  jet.on('data', data => {
    console.log(data); // 'hello' from server.
  });

  jet.send({thank: 'you'}).then(
    () => console.log('data sent'),
    error => console.error(error),
  );
});
```

### Power Jet

**Server**

```ts
class ServerPowerJet extends PowerJet {
  async test(timeout: number): Promise<string> {
    return await new Promise<string>(resolve => {
      setTimeout(resolve, timeout, 'hello, jet!');
    });
  }
}

let server = Net.createServer(socket => {
  new ServerPowerJet(socket);
});

server.listen(10047);
```

**Client**

```ts
let socket = Net.connect(10047, () => {
  // Note: Client can also have derived `PowerJet` with methods to be called by server.
  let jet = new PowerJet(socket);

  jet.call('test', 1000).then(console.log); // 'hello, jet!' after 1000ms.
});
```

### Encrypted Jet

**Server**

```ts
let server = Net.createServer(socket => {
  let jet = new Jet(socket, {
    crypto: {
      algorithm: 'aes-256-cfb',
      password: 'some password',
    },
  });

  jet.on('data', data => {
    console.log(data); // {thank: 'you'} from client.
  });

  jet.send('hello').then(
    () => console.log('"hello" sent'),
    error => console.error(error),
  );
});

server.listen(10047);
```

**Client**

```ts
let socket = Net.connect(10047, () => {
  let jet = new Jet(socket, {
    crypto: {
      algorithm: 'aes-256-cfb',
      password: 'some password',
    },
  });

  jet.on('data', data => {
    console.log(data); // 'hello' from server.
  });

  jet.send({thank: 'you'}).then(
    () => console.log('data sent'),
    error => console.error(error),
  );
});
```

## License

MIT License.

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