it-handshake

Create handshakes for binary protocols with iterable streams

Usage no npm install needed!

<script type="module">
  import itHandshake from 'https://cdn.skypack.dev/it-handshake';
</script>

README

it-handshake

Build Status dependencies Status JavaScript Style Guide

Create handshakes for binary protocols with iterable streams.

Install

npm install it-handshake

Usage

See ./example/index.js

API

handshake(duplex)

Returns a new handshake instance that produces BufferList objects.

shake.write(message)

  • message: String|Buffer|BufferList

shake.read()

Returns the next BufferList message in the stream.

shake.rest()

Ends the writer. This is necessary for continuing to pipe data through shake.stream

shake.stream

The duplex iterable stream to be used once the handshake is complete.

shake.reader

The underyling it-reader used by shake.read(). While direct usage of the reader is typically unnecessary, it is available for advanced usage.

shake.writer

The underyling writer, it-pushable, used by shake.write(). While direct usage of the writer is typically unnecessary, it is available for advanced usage.

Related

License

MIT © Jacob Heun