updated sys and created publi

2017-12-21 18:09:49 +01:00
parent 2a6e2ff863
commit cefd1c2ad0
9509 changed files with 744901 additions and 32263 deletions
@@ -0,0 +1,50 @@
+# BufferStreams
+
+[![NPM version](https://badge.fury.io/js/bufferstreams.png)](https://npmjs.org/package/bufferstreams) [![Build Status](https://travis-ci.org/nfroidure/BufferStreams.png?branch=master)](https://travis-ci.org/nfroidure/BufferStreams) [![Dependency Status](https://david-dm.org/nfroidure/bufferstreams.png)](https://david-dm.org/nfroidure/bufferstreams) [![devDependency Status](https://david-dm.org/nfroidure/bufferstreams/dev-status.png)](https://david-dm.org/nfroidure/bufferstreams#info=devDependencies) [![Coverage Status](https://coveralls.io/repos/nfroidure/BufferStreams/badge.png?branch=master)](https://coveralls.io/r/nfroidure/BufferStreams?branch=master) [![Code Climate](https://codeclimate.com/github/nfroidure/BufferStreams.png)](https://codeclimate.com/github/nfroidure/BufferStreams)
+
+BufferStreams abstracts streams to allow you to deal with their whole content 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](https://npmjs.org/package/bufferstreams):
+```sh
+npm install bufferstreams --save
+```
+Then, in your scripts:
+```js
+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').replace('foo', 'bar'));
+
+    // cb is a callback to pass the result back to the piped out stream
+    // first argument is an error that will be emitted if any
+    // the second argument is the modified buffer
+    cb(null, buf);
+
+  }))
+  .pipe(Fs.createWriteStream('output.txt'));
+```
+
+Note that you can use BufferStream with the objectMode option. In this case, the
+ given buffer will be an array containing the streamed objects:
+```js
+new BufferStreams({objectMode: true}, myCallback);
+```
+
+## Contributing
+Feel free to pull your code if you agree with publishing it under the MIT license.
+