stream-read-all - npm Package Compare versions

Comparing version 0.1.2 to 1.0.0

index.js

@@ -50,6 +50,4 @@ 'use strict'
     })
-    streamReader.on('error', (err) => {
-      reject(err)
-    })
+    streamReader.on('error', reject)
   })
 }

package.json

 {
   "name": "stream-read-all",
   "author": "Lloyd Brookes <[e-mail]>",
-  "version": "0.1.2",
-  "description": "stream-read-all",
+  "version": "1.0.0",
+  "description": "Returns a promise which resolves once all data in the supplied stream has been read",
   "repository": "https://github.com/75lb/stream-read-all.git",
@@ -18,13 +18,13 @@ "keywords": [
   "engines": {
-    "node": ">=4"
+    "node": ">=6"
   },
   "scripts": {
     "test": "test-runner test/*.js",
-    "cover": "istanbul cover ./node_modules/.bin/test-runner test/*.js && cat coverage/lcov.info | ./node_modules/.bin/coveralls && echo"
+    "cover": "nyc --reporter=text-lcov npm test | coveralls"
   },
   "dependencies": {},
   "devDependencies": {
-    "coveralls": "^2.13.1",
-    "test-runner": "^0.4.0"
+    "coveralls": "^3.0.1",
+    "test-runner": "^0.5.0"
   }
 }

README.md

@@ -10,11 +10,24 @@ [![view on npm](https://img.shields.io/npm/v/stream-read-all.svg)](https://www.npmjs.org/package/stream-read-all)
 
-Returns a promise which resolves once all data has been read.
+Returns a promise which resolves once all data in the supplied stream has been read.
 
+This example script...
+
 ```js
-const stream = fs.createReadStream('./package.json')
-const data = await streamReadAll(stream)
+async function printInput () {
+  const streamReadAll = require('stream-read-all')
+  const stdin = await streamReadAll(process.stdin)
+  console.log(stdin.toString())
+}
+printInput()
 ```
 
+...prints this output.
+
+```
+$ echo Hello | node example.js
+Hello
+```
+
 * * *
 
-&copy; 2017 Lloyd Brookes <[e-mail]>.
+&copy; 2017-18 Lloyd Brookes <[e-mail]>.

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

51517

increased by3.71%

Number of package files

17

increased by6.25%

Lines of code

549

increased by11.81%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

32

increased by68.42%

No dependency changes