Socket
Socket
Sign inDemoInstall

bufferstreams

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

bufferstreams

Abstract streams to deal with the whole buffered contents.


Version published
Weekly downloads
392K
increased by0.97%
Maintainers
1
Weekly downloads
 
Created
Source

BufferStreams NPM version Build Status

BufferStreams abstracts streams to allow you to deal with the whole contents in a single buffer when it becomes necessary (by example: a legacy library that do not support streams).

It is not a good practice, just some glue. Using BufferStreams means:

  • there is no library dealing with streams for your needs
  • you filled an issue to the wrapped library to support streams

## Usage Install the npm module:

npm install bufferstreams --save

Then, in your scripts:

var BufferStreams = require('bufferstreams');

Fs.createReadStream('input.txt')
  .pipe(new BufferStreams(function(err, buf, cb) {

    // err will be filled with an error if the piped in stream emits one.
    if(err) {
      throw err;
    }

    // buf will contain the whole piped in stream contents
    buf = Buffer(buf.toString(utf-8).repalce('foo', 'bar'));

    // cb is a callback to pass the result back to the piped out stream
    // first argument is an error that wil be emitted if one
    // the second argument is the modified buffer
    cb(null, buf);

  }))
  .pipe(Fs.createWriteStream('output.txt'));

Contributing

Feel free to pull your code if you agree with publishing it under the MIT license.

Keywords

FAQs

Package last updated on 05 Jan 2014

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