express-formidable2 v1.0.3

express-formidable2

An Express middleware of Formidable that just works.

What are Express, Formidable, and this?

Express is a fast, unopinionated, minimalist web framework for Node.js.

Formidable is a Node.js module for parsing form data, including multipart/form-data file upload.

So, express-formidable2 is something like a bridge between them, specifically an Express middleware implementation of Formidable.

It aims to just work.

Install

npm install express-formidable2

How to use

const express = require('express');
const formidable = require('express-formidable2');

var app = express();

app.use(formidable());

app.post('/upload', (req, res) => {
  req.fields; // contains non-file fields
  req.files; // contains files
});

And that's it.

express-formidable2 can basically parse form types Formidable can handle, including application/x-www-form-urlencoded, application/json, and multipart/form-data.

Option

app.use(formidable(opts,events));

opts & events are options which can be set to form in Formidable. For example:

app.use(formidable({
  encoding: 'utf-8',
  uploadDir: '/my/dir',
  multiples: true, // req.files to be arrays of files
},[
  {
    type: "progress",
    func: (bytesReceived,bytesExpected) => {
      // write code
    }
  },
  {
    type: "file",
    func: (name,file) => {
      // write code
    }
  }
]);

For the detail, please refer to the Formidable API.

Contribute

git clone https://github.com/noraesae/express-formidable2.git
cd express-formidable2
npm install

To lint and test:

npm test

License

MIT