gcs-resumable-upload - npm Package Compare versions

Comparing version 2.3.2 to 2.3.3

CHANGELOG.md

@@ -7,2 +7,9 @@ # Changelog
 
+### [2.3.3](https://www.github.com/googleapis/gcs-resumable-upload/compare/v2.3.2...v2.3.3) (2020-03-06)
+
+
+### Bug Fixes
+
+* **docs:** progress event in readme file  ([#313](https://www.github.com/googleapis/gcs-resumable-upload/issues/313)) ([0dfdd07](https://www.github.com/googleapis/gcs-resumable-upload/commit/0dfdd07d7472e63eb19e5c216171a13a517bf29a))
+
 ### [2.3.2](https://www.github.com/googleapis/gcs-resumable-upload/compare/v2.3.1...v2.3.2) (2019-12-05)
@@ -9,0 +16,0 @@

package.json

 {
   "name": "gcs-resumable-upload",
-  "version": "2.3.2",
+  "version": "2.3.3",
   "description": "Upload a file to Google Cloud Storage with built-in resumable behavior",
@@ -55,3 +55,3 @@ "repository": "googleapis/gcs-resumable-upload",
     "@types/is-stream": "^1.1.0",
-    "@types/mocha": "^5.2.1",
+    "@types/mocha": "^7.0.0",
     "@types/mockery": "^1.4.29",
@@ -63,15 +63,13 @@ "@types/nock": "^10.0.0",
     "assert-rejects": "^1.0.0",
-    "c8": "^6.0.0",
+    "c8": "^7.0.0",
     "codecov": "^3.0.4",
     "gts": "^1.0.0",
-    "intelli-espower-loader": "^1.0.1",
     "is-stream": "^2.0.0",
-    "linkinator": "^1.5.0",
-    "mocha": "^6.1.4",
+    "linkinator": "^2.0.0",
+    "mocha": "^7.0.0",
     "mockery": "^2.1.0",
-    "nock": "^11.0.0",
-    "sinon": "^7.3.2",
-    "source-map-support": "^0.5.6",
+    "nock": "^12.0.0",
+    "sinon": "^9.0.0",
     "typescript": "3.6.4"
   }
 }

README.md

@@ -13,2 +13,6 @@ # gcs-resumable-upload
   .pipe(upload({ bucket: 'legally-owned-movies', file: 'titanic.mov' }))
+  .on('progress', (progress) => {
+    console.log('Progress event:')
+    console.log('\t bytes: ', progress.bytesWritten);
+  })
   .on('finish', () => {
@@ -241,2 +245,18 @@ // Uploaded!
 
+#### .on('progress', function (progress) {})
+
+#### progress
+
+- Type: `Object`
+
+##### progress.bytesWritten
+
+- Type: `number`
+
+##### progress.contentLength
+
+- Type: `number`
+
+Progress event provides upload stats like Transferred Bytes and content length.
+
 #### .on('finish', function () {})
@@ -243,0 +263,0 @@

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

60839

increased by1.11%

Dev dependency count

20

decreased by-9.09%

Number of lines in readme file

287

increased by7.49%

No dependency changes