busboy-express

An express middleware for busboy, with TypeScript typings.

Works with ES5 if you include a global Promise library.

Table of Contents

• Installation
• Usage
  • Middleware options
  • Debug messages
• License

Installation

$ npm install busboy-express

Usage

Note: if you get errors about incompatible definitions of Express.Request.files, enable the skipLibCheck TypeScript compiler option.

• It is recommened to only include the middleware on routes that actually require it.
• On routes that have included the middleware, req.fields and req.files will be key-value objects, with the keys being the fieldnames and the values being arrays of values (for fields) or file descriptor objects (for files).

Note: Don't forget to cleanup by running cleanup(req). Your route handler doesn't have to wait for its completion.

const busboy = require('busboy-express');
const express = require('express');

const app = express();

app.post('/upload', busboy({fields: ['allowedfield'], files: ['allowedfile']}), (req, res, next) => {
  for (const fieldname in req.files) {
    for (const file of req.files[fieldname]) {
      moveUploadedFile(file.path, './uploads/' + file.originalFilename);
    }
  }
  
  for (const fieldname of req.fields) {
    // process field
  }
  
  busboy.cleanup(req);
});

Middleware options

The busboy middleware takes an Options object. This object extends Busboy's own Config object (the object passed to the Busboy constructor).

Documentation for the native busboy options object can be found at https://github.com/mscdex/busboy#busboy-methods.

It augments that object with a few options:

{
  "multipartOnly": true,
  "uploadPath": os.tmpdir(),
  "fields": true,
  "files": []
}

multipartOnly (boolean)

Handle multipart/form-data requests only. This enhances compatiblity if you are using another module to handle urlencoded requests.

uploadPath (string)

The path to which files should be uploaded.

fields (boolean/string[])

An array of fieldnames that should be accepted as fields. No other fields will be processed when populating req.fields.

Setting this to true allows all fields. Limits as defined through the native busboy options still apply.

files (boolean/string[])

An array of fieldnames that should be accepted as files. No other files will be processed when populating req.files.

Setting this to true allows all files. Limits as defined through the native busboy options still apply. Use with caution and consider setting a file count/file size limit.

Debug messages

This module uses debug with the busboy-express namespace.

License

MIT License

Copyright (c) 2019 elunic AG/William Hefter [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.