# yakety

> Bi-directional node to node messaging and request-reply.

Latest version **0.1.6** (published 2017-06-25) · MIT license · 0 weekly downloads

## Install

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

## 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.6 |
| Published | 2017-06-25 |
| First published | 2016-12-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=1 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Mark W. B. Ashcroft |
| Maintainers | fluidecho |
| Keywords | req-rep, request-reply, messaging, rpc |

## Links

- npm: https://www.npmjs.com/package/yakety
- Repository: https://github.com/fluidecho/yakety
- Issues: http://github.com/fluidecho/yakety/issues
- npm.io page: https://npm.io/package/yakety

## Dependencies (3)

- [smp](https://npm.io/package/smp.md) 1.1.3
- [preview](https://npm.io/package/preview.md) ~0.1.3
- [naked-websocket](https://npm.io/package/naked-websocket.md) ~0.1.7

## Recent versions

- 0.1.6 (latest) — 2017-06-25
- 0.1.5 — 2017-06-24
- 0.1.4 — 2017-03-31
- 0.1.3 — 2017-03-22
- 0.1.2 — 2017-01-12
- 0.1.1 — 2017-01-09
- 0.1.0 — 2017-01-05
- 0.0.9 — 2017-01-05
- 0.0.8 — 2017-01-05
- 0.0.7 — 2017-01-05
- 0.0.6 — 2016-12-31
- 0.0.5 — 2016-12-22
- 0.0.4 — 2016-12-22
- 0.0.2 — 2016-12-22
- 0.0.1 — 2016-12-21

## README

# Yakety

[![build status][travis-image]][travis-url]
[![NPM version][npm-image]][npm-url]
[![node version][node-image]][node-url]

[travis-image]: https://api.travis-ci.org/fluidecho/yakety.png
[travis-url]: https://travis-ci.org/fluidecho/yakety
[npm-image]: https://img.shields.io/npm/v/yakety.svg?style=flat-square
[npm-url]: https://npmjs.org/package/yakety
[node-image]: https://img.shields.io/badge/node.js-%3E=_1-blue.svg?style=flat-square
[node-url]: http://nodejs.org/download/

Bi-directional node to node messaging and request-reply.  

Both the server and client can send and receive messages as well as requests-replys.

Yakety is a bit like a RESTful service, but allows the server to instigate requests to the client, plus fire-and-forget messages. Yakety will also maintain persistent connections by automatically reconnecting clients. Yakety is for back-end node to node communications, not a browser compatible solution.

## Installation

```
npm install yakety
```


## Examples

_See examples folder._

#### Server example

```js
const yakety = require('yakety');

var options = {
  protocol: 'ws',            // or 'wss' for secure.
  slowHandshake: true,      // true: can do your own authorization and handshake or close socket.
  port: 8080
};


var server = new yakety.server();

server.bind(options);

// auth clients:
server.on('authorize', function(client) {
  console.log('authorize client');

  if ( !client.headers.authorization ) {
    client.goodbye(401);
  } else if ( client.headers.authorization.password === 'password' ) {
    client.handshake();
  } else {
    client.goodbye(401);
  }

});

server.on('connected', function(client) {
  console.log('client connected');
  client.request('yakMethod', 'yakety yak?', function(err, reply) {
    if ( err ) {
      console.log('client.request reply error', err);
      return;
    }
    console.log('got reply back:', reply.toString());
    client.message('this is rock and roll.');
  });

  client.on('message', function(message, meta) {
    console.log('server got message:', message.toString());
  });

  client.on('request', function(meta, req, rep) {
    console.log('got request, method: ' + meta.method + ', req:', req.toString());
    rep('yak!');
  });

  client.on('close', function(client) {
    console.log('client close-ed');
  });

});

```

#### Client example

```js
const yakety = require('yakety');

var options = {
  protocol: 'ws',      // or 'wss' for secure.
  hostname: '127.0.0.1',
  port: 8080,
  path: '/foo/bar/?hello=world',
  auth: 'username:password'
};

var client = new yakety.client();

client.connect(options);

client.message('hello');

client.request('yaketyyakMethod', 'yakety?', function(err, reply) {
  if ( err ) {
    console.log('client.request reply error', err);
    return;
  }
  console.log('got reply to yakety?:', reply.toString());
});

client.on('message', function(message, meta) {
  console.log('got message:', message.toString());
});

client.on('request', function(meta, req, rep) {
  console.log('got request, method: ' + meta.method + ', req:', req.toString());
  rep('Talking back!');
});

client.on('error', function(err) {
  console.log('client-app-err', err);
});

```

## Test

```
npm test
```

## Notes

Yakety is built on top of these open protocols: [naked-websocket](https://www.npmjs.com/package/naked-websocket) for TCP/TLS network link and [SMP](https://www.npmjs.com/package/smp) for message framing, with any payload codec: String, Buffer, JSON, MsgPack, etc.  


## License

Choose either: [MIT](http://opensource.org/licenses/MIT) or [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0).

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