Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

stream-collect

Package Overview
Dependencies
Maintainers
1
Versions
16
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

stream-collect

Collects the output of a stream

  • 1.0.0
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Stream collect

Collects a readable streams data as a string buffer or, for object streams, an array.

npm install stream-collect

collect( stream, [encoding], [cb] )

Collect the contents of a stream. The collected data will either be a Buffer, String or Array depending on whether encoding has been supplied, or it is an object stream.

Returns a Promise that will resolve with the collected data.

  • stream the stream to collect
  • encoding the encoding to return data in
  • cb a callback that will be called with the collected data.
var collect = require('stream-collect');	
var file = fs.createReadableStream( 'myfile' );

// Collect using a promise
collect(file)
	.then( function(theWholeFile) {
		// Do something
	} );

// Collect using a callback
collect( file, function(theWholeFile) {
	// Do something
} )

// Specify an encoding
collect( file, 'base64' )
	.then( function(theWholeFileInBase64) {
		// Do something
	} );

collect.PassThrough()

A PassThrough stream that has been augmented with a collect event. This will be emitted in the end event with the collected contents of the stream.

var collect = require('stream-collect');

var file = fs.createReadableStream( 'myfile' );
file.pipe( new collect.PassThrough() )
	.on( 'collect', function(data) {
		// data = contents of the file
	} );

collect.addToStream(stream)

Augment any stream with the collect event used on collect.PassThrough.

Returns the augmented stream.

FAQs

Package last updated on 01 Feb 2015

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