multiparty-express

multiparty-express

An express middleware for multiparty, with TypeScript typings.

Table of Contents

• Installation
• Usage
  • Debug messages
• TODO
• License

Installation

$ npm install multiparty-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).
• The file descriptor objects are those used by multiparty.
• Don't forget to cleanup by running cleanup(req). Your route handler doesn't have to wait for its completion.

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

const app = express();

app.post('/upload', multiparty(), (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
  }
  
  multiparty.cleanup(req);
});

Debug messages

This module uses debug with the multiparty namespace.

TODO

• Allow options to configure which fields/files should actually be processed
• Alows multiparty options

License

MIT License

Copyright (c) 2019 elunic AG/William Hefter [e-mail]

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.