Socket
Socket
Sign inDemoInstall

it-goodbye

Package Overview
Dependencies
Maintainers
2
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

it-goodbye

Add a goodbye handshake to a duplex async iterable


Version published
Maintainers
2
Created
Source

it-goodbye

codecov CI

Add a goodbye handshake to a duplex async iterable

About

Add a goodbye handshake to a duplex async iterable.

In a uniplex stream, the end event signifies the end of the stream. But a duplex stream, it's a little more complicated - there are two paired streams that may end independently.

node's net module has an allowHalfOpen mode, but support for this method is patchy - more often, by default duplex streams are like a telephone - when one side hangs up, both streams are terminated. Humans deal with this problem by moving stream termination into the "application" layer - it's polite to say "goodbye", and to wait to receive "goodbye" before call termination.

Example

Given another duplex stream, wrap it with it-goodbye.

goodbye(stream, goodbye_message) takes a duplex stream and a message (by default, the string "GOODBYE"), this must be encodable whatever codec the stream uses. The codec should probably be applied outside of it-goodbye.

import { goodbye } from 'it-goodbye'

// a duplex stream from somewhere...
var duplex = whatever.createStream()

return goodbye(duplex, 'GoodBye')

Install

$ npm i it-goodbye

Browser <script> tag

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

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

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.

FAQs

Package last updated on 28 Dec 2023

Did you know?

Socket

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc