chainsafe / it-handshake

Create handshakes for binary protocols with iterable streams.

it-handshake

Create handshakes for binary protocols with iterable streams.

Install

npm install it-handshake

Usage

See ./example/index.js

API

handshake(duplex)

• duplex: DuplexIterable A duplex iterable stream

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

• it-reader
• it-pushable
• it-pair
• it-pipe

License

MIT © Jacob Heun