co-busboy - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

History.md

 
+2.0.1 / 2023-05-07
+==================
+
+**fixes**
+  * [[`448fc4b`](http://github.com/cojs/busboy/commit/448fc4b7af677009749a9f4ebfb9048ec3b20f53)] - fix: catch file stream error (#31) (Xin Hao <<[e-mail]>>)
+
 2.0.0 / 2022-09-16
@@ -3,0 +9,0 @@ ==================

index.js

@@ -104,2 +104,14 @@ var Busboy = require('busboy')
   function onFile(fieldname, file, info) {
+    function onFileError(err) {
+      lastError = err
+    }
+    function onFileCleanup() {
+      file.removeListener('error', onFileError)
+      file.removeListener('end', onFileCleanup)
+      file.removeListener('close', onFileCleanup)
+    }
+    file.on('error', onFileError)
+    file.on('end', onFileCleanup)
+    file.on('close', onFileCleanup)
+
     var filename = info.filename
@@ -106,0 +118,0 @@ var encoding = info.encoding

package.json

 {
   "name": "co-busboy",
   "description": "Busboy multipart parser as a yieldable",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "author": {
@@ -37,2 +37,3 @@ "name": "Jonathan Ong",
     "test": "mocha **/*.test.js",
+    "lint": "echo 'ignore'",
     "ci": "c8 npm test"
@@ -39,0 +40,0 @@ },

README.md

 # co busboy
 
 [![NPM version][npm-image]][npm-url]
-[![build status][travis-image]][travis-url]
+[![Node.js CI](https://github.com/cojs/busboy/actions/workflows/nodejs.yml/badge.svg)](https://github.com/cojs/busboy/actions/workflows/nodejs.yml)
 [![Test coverage][codecov-image]][codecov-url]
-[![David deps][david-image]][david-url]
 [![npm download][download-image]][download-url]
@@ -11,8 +10,4 @@
 [npm-url]: https://npmjs.org/package/co-busboy
-[travis-image]: https://img.shields.io/travis/cojs/busboy.svg?style=flat-square
-[travis-url]: https://travis-ci.org/cojs/busboy
 [codecov-image]: https://codecov.io/github/cojs/busboy/coverage.svg?branch=master
 [codecov-url]: https://codecov.io/github/cojs/busboy?branch=master
-[david-image]: https://img.shields.io/david/cojs/busboy.svg?style=flat-square
-[david-url]: https://david-dm.org/cojs/busboy
 [download-image]: https://img.shields.io/npm/dm/co-busboy.svg?style=flat-square
@@ -26,11 +21,11 @@ [download-url]: https://npmjs.org/package/co-busboy
 ```js
-var parse = require('co-busboy')
+const parse = require('co-busboy')
 
-app.use(function* (next) {
+app.use(async (next) => {
   // the body isn't multipart, so busboy can't parse it
-  if (!this.request.is('multipart/*')) return yield next
+  if (!this.request.is('multipart/*')) return await next()
 
-  var parts = parse(this)
-  var part
-  while (part = yield parts()) {
+  const parts = parse(this)
+  let part
+  while (part = await parts()) {
     if (part.length) {
@@ -57,10 +52,10 @@ // arrays are busboy fields
 ```js
-var parse = require('co-busboy')
+const parse = require('co-busboy')
 
-app.use(function* (next) {
-  var parts = parse(this, {
+app.use(async (next) => {
+  const parts = parse(this, {
     autoFields: true
   })
-  var part
-  while (part = yield parts()) {
+  let part
+  while (part = await parts()) {
     // it's a stream
@@ -83,8 +78,8 @@ part.pipe(fs.createWriteStream('some file.txt'))
 ```js
-var parse = require('co-busboy')
+const parse = require('co-busboy')
 
-app.use(function* (next) {
-  var ctx = this
-  var parts = parse(this, {
-    checkField: function (name, value) {
+app.use(async (next) => {
+  const ctx = this
+  const parts = parse(this, {
+    checkField: (name, value) => {
       if (name === '_csrf' && !checkCSRF(ctx, value)) {
@@ -97,4 +92,4 @@ var err =  new Error('invalid csrf token')
   })
-  var part
-  while (part = yield parts()) {
+  let part
+  while (part = await parts()) {
     // ...
@@ -111,10 +106,10 @@ }
 ```js
-var parse = require('co-busboy')
-var path = require('path')
+const parse = require('co-busboy')
+const path = require('path')
 
-app.use(function* (next) {
-  var ctx = this
-  var parts = parse(this, {
+app.use(async (next) => {
+  const ctx = this
+  const parts = parse(this, {
     // only allow upload `.jpg` files
-    checkFile: function (fieldname, file, filename) {
+    checkFile: (fieldname, file, filename) => {
       if (path.extname(filename) !== '.jpg') {
@@ -127,4 +122,4 @@ var err = new Error('invalid jpg image')
   })
-  var part
-  while (part = yield parts()) {
+  let part
+  while (part = await parts()) {
     // ...
@@ -140,4 +135,4 @@ }
 ```js
-var parse = require('co-busboy')
-var parts = parse(stream, {
+const parse = require('co-busboy')
+const parts = parse(stream, {
   autoFields: true
@@ -152,5 +147,5 @@ })
 
-### part = yield parts()
+### part = await parts()
 
-Yield the next part.
+Await the next part.
 If `autoFields: true`, this will always be a file stream.
@@ -157,0 +152,0 @@ Otherwise, it will be a [field](https://github.com/mscdex/busboy#busboy-special-events) as an array.

No alert changes

Improved metrics

Total package byte prevSize

12531

3.45%

Lines of code

132

9.09%

Worsened metrics

Number of lines in readme file

193

-2.53%

No dependency changes