New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →

it-handshake

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

it-handshake

Create handshakes for binary protocols with iterable streams

4.1.1
Source
npm

Version published: 3 years ago

Weekly downloads: 3.2K; increased by28.5%

Maintainers: 1

Weekly downloads

Created: 5 years ago

Source

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.

License

Keywords

FAQs

What is it-handshake?

Is it-handshake popular?

Is it-handshake well maintained?

Package last updated on 10 Aug 2022

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

it-handshake