buffer-peek-stream - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

 # buffer-peek-stream changelog
 
+## 1.0.1 (2015/06/09)
+
+  - documentation fixes (no code change)
+
 ## 1.0.0 (2015/05/19)
@@ -23,2 +27,2 @@
 
- - initial version
+ - initial version

package.json

 {
   "name": "buffer-peek-stream",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Transform stream that lets you inspect the start of a ReadStream before deciding what to do with it",
@@ -35,2 +35,2 @@ "main": "buffer-peek-stream.js",
   }
-}
+}

README.md

@@ -22,10 +22,10 @@ # node-buffer-peek-stream
 ```
-var peek = require('./buffer-peek-stream');
+var peek = require('buffer-peek-stream');
 var readstream = fs.createReadStream('package.json');
 
-peek(readstream, 65536, function (err, data) {
+peek(readstream, 65536, function (err, data, outputStream) {
   if (err) throw err;
 
-  // readstream is ready to be piped somewhere else
-  readstream.pipe(somewhere_else);
+  // outputStream is ready to be piped somewhere else
+  outputStream.pipe(somewhere_else);
 });
@@ -36,3 +36,3 @@ ```
 ```
-var PeekStream = require('./buffer-peek-stream').Constructor;
+var PeekStream = require('buffer-peek-stream').BufferPeekStream;
 
@@ -46,6 +46,8 @@ var peek = new PeekStream(65536);
   // readstream is ready to be piped somewhere else
-  readstream.pipe(somewhere_else);
+  peek.pipe(somewhere_else);
 });
 
-stream.pipe(peek);
+readstream.pipe(peek);
+
+// alternatively pipe `peek` here instead of in `data` callback
 ```
@@ -55,2 +57,2 @@
 ## Licence
-MIT
+MIT

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9347

increased by1.52%

Number of lines in readme file

55

increased by5.77%

No dependency changes