it-handshake

Create handshakes for binary protocols with iterable streams

Table of contents

• Install
  • Browser <script> tag
• API
  • handshake(duplex)
  • shake.write(message)
  • shake.read()
  • shake.rest()
  • shake.stream
  • shake.reader
  • shake.writer
• Related
• API Docs
• License
• Contribution

Install

$ npm i it-handshake

Browser <script> tag

Loading this module through a script tag will make it's exports available as ItHandshake in the global namespace.

<script src="https://unpkg.com/it-handshake/dist/index.min.js"></script>

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

API Docs

• https://jacobheun.github.io/it-handshake

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.