progress-stream - npm Package Compare versions

Comparing version 1.2.0 to 2.0.0

package.json

 {
   "name": "progress-stream",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "Read the progress of a stream",
@@ -23,4 +23,4 @@ "repository": {
   "dependencies": {
-    "through2": "~0.2.3",
-    "speedometer": "~0.1.2"
+    "speedometer": "~1.0.0",
+    "through2": "~2.0.3"
   },
@@ -27,0 +27,0 @@ "devDependencies": {

README.md

@@ -5,3 +5,3 @@ # progress-stream
 
-Gets the lengths of the stream automatically if you're using the request or http module. You can also pass the length on initiation. Progress-stream will also check to see if the stream already have a length property.
+Gets the length of the stream automatically if you're using the request or http module. You can also pass the length on initiation. Progress-stream will also check to see if the stream already has a length property.
 
@@ -21,3 +21,3 @@ npm install progress-stream
 	length: stat.size,
-	time: 100
+	time: 100 /* ms */
 });
@@ -66,5 +66,5 @@
 
-### .progress
+### .progress()
 
-You can get the progress from the progress property.
+You can get the progress from the progress function.
 
@@ -74,3 +74,3 @@ ``` js
 
-console.log(str.progress);
+console.log(str.progress());
 
@@ -104,3 +104,3 @@ /*
 
-Sets how often progress events is emitted. If omitted then defaults to emit every time a chunk is received.
+Sets how often progress events are emitted in ms. If omitted then the default is to do so every time a chunk is received.
 
@@ -121,3 +121,3 @@ ### speed(integer)
 
-If you want to set how much data have previous been downloaded. Useful for a resumed download.
+If you want to set the size of previously downloaded data. Useful for a resumed download.
 
@@ -124,0 +124,0 @@ ## Examples

No alert changes

Improved metrics

Total package byte prevSize

9925

increased by0.2%

Dependency changes

• + Addedisarray@1.0.0(transitive)

• + Addedprocess-nextick-args@2.0.1(transitive)

• + Addedreadable-stream@2.3.8(transitive)

• + Addedsafe-buffer@5.1.2(transitive)

• + Addedspeedometer@1.0.0(transitive)

• + Addedstring_decoder@1.1.1(transitive)

• + Addedthrough2@2.0.5(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedxtend@4.0.2(transitive)

• - Removedisarray@0.0.1(transitive)

• - Removedobject-keys@0.4.0(transitive)

• - Removedreadable-stream@1.1.14(transitive)

• - Removedspeedometer@0.1.4(transitive)

• - Removedstring_decoder@0.10.31(transitive)

• - Removedthrough2@0.2.3(transitive)

• - Removedxtend@2.1.2(transitive)

• Updatedspeedometer@~1.0.0

• Updatedthrough2@~2.0.3