Skip to content
Connect middleware for busboy
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE initial commit Sep 7, 2013
README.md Add troubleshooting section to README.md Mar 3, 2015
index.js
package.json bump version Oct 2, 2014

README.md

Description

Connect middleware for busboy.

Requirements

Install

npm install connect-busboy

Example

var busboy = require('connect-busboy');

// default options, no immediate parsing
app.use(busboy());
// ...
app.use(function(req, res) {
  if (req.busboy) {
    req.busboy.on('file', function(fieldname, file, filename, encoding, mimetype) {
      // ...
    });
    req.busboy.on('field', function(key, value, keyTruncated, valueTruncated) {
      // ...
    });
    req.pipe(req.busboy);
  }
  // etc ...
});

// default options, immediately start reading from the request stream and
// parsing
app.use(busboy({ immediate: true }));
// ...
app.use(function(req, res) {
  if (req.busboy) {
    req.busboy.on('file', function(fieldname, file, filename, encoding, mimetype) {
      // ...
    });
    req.busboy.on('field', function(key, value, keyTruncated, valueTruncated) {
      // ...
    });
  }
  // etc ...
});

// any valid Busboy options can be passed in also
app.use(busboy({
  highWaterMark: 2 * 1024 * 1024,
  limits: {
    fileSize: 10 * 1024 * 1024
  }
}));

Troubleshooting

'TypeError: Cannot call method 'on' of undefined'

If you find that req.busboy is not defined in your code when you expect it to be, check that the following conditions are met. If they are not, req.busboy won't be defined:

  1. The request method is not GET or HEAD
  2. The Content-Type header specifies that is "application/x-www-formurlencoded" or starts with "multipart/*"
  3. The Content-Length header is defined or chunked transfer encoding is in use. This criteria should be met by all well-behaved HTTP clients and is unlikely the problem.
You can’t perform that action at this time.