Socket
Socket
Sign inDemoInstall

lead

Package Overview
Dependencies
0
Maintainers
2
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    lead

Sink your streams.


Version published
Weekly downloads
1.8M
decreased by-0.69%
Maintainers
2
Install size
4.59 kB
Created
Weekly downloads
 

Changelog

Source

4.0.0 (2022-09-22)

⚠ BREAKING CHANGES

  • Remove piping to a Writable and instead call resume on stream

Features

  • Remove piping to a Writable and instead call resume on stream (27324d6)

Bug Fixes

  • Ensure project works with different streams (#8) (27324d6)
  • Use listenerCount API on streams (27324d6)

Readme

Source

lead

NPM version Downloads Build Status Coveralls Status

Sink your streams.

Usage

var { Readable, Transform } = require('streamx');
var sink = require('lead');

// Might be used as a Transform or Writeable
var maybeThrough = new Transform({
  transform(chunk, cb) {
    // processing
    cb(null, chunk);
  },
});

Readable.from(['hello', 'world'])
  // Sink it to behave like a Writeable
  .pipe(sink(maybeThrough));

API

sink(stream)

Takes a stream to sink and returns the same stream. Sets up event listeners to infer if the stream is being used as a Transform or Writeable stream and sinks it on nextTick if necessary. If the stream is being used as a Transform stream but becomes unpiped, it will be sunk. Respects pipe, on('data') and on('readable') handlers.

License

MIT

Keywords

FAQs

Last updated on 22 Sep 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

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