Socket
Socket
Sign inDemoInstall

it-handshake

Package Overview
Dependencies
7
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    it-handshake

Create handshakes for binary protocols with iterable streams


Version published
Weekly downloads
6.4K
decreased by-37.05%
Maintainers
1
Install size
486 kB
Created
Weekly downloads
 

Changelog

Source

4.1.3 (2023-04-18)

Dependencies

  • update all it-* deps and aegir (#57) (e133b14)

Readme

Source

it-handshake

codecov CI

Create handshakes for binary protocols with iterable streams

Table of contents

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)

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.

API Docs

License

Licensed under either of

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.

Keywords

FAQs

Last updated on 18 Apr 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc