Express js form data

Question

Can someone please tell me the recommended (up to date) way to get POSTed form data in express.

So many tutorials/ posts etc talk about bodyParser but this is no longer bundled with Express and other blogs etc recommend using urlencoded directly, but now this is not available either.

Trying to find accurate information on these frameworks or technologies is doing my head in.

BTW what I am intrerested in is very simple and small form data

Solution 1

You should install body-parser through npm-install. Now it comes as a separate middleware.

After that add following line in your app.js

var bodyParser = require('body-parser');
app.use(bodyParser.json());
app.use(bodyParser.urlencoded());
// in latest body-parser use like below.
app.use(bodyParser.urlencoded({ extended: true }));

It parses the post request as an object. You will get your variables in req.body.

In your post request handler.

app.post('/post',function(request,response){
   console.log(request.body) //you will get your data in this as object.
})

Edit 1

The answer above was for the question specifically asked, the OP was looking for the bodyParser(deprecated) which was not part of express anymore.

Since the title of the question is very generic and the answer doesn't include all aspects of form-data, I will put @StLia's answer as an edit.

Body-Parser Readme

This does not handle multipart bodies, due to their complex and typically large nature. For multipart bodies, you may be interested in the following modules:

• busboy and connect-busboy
• multiparty and connect-multiparty
• formidable
• multer

Solution 2

You can make use of express-formidable module to that. install 'express-formidable' by the following command

npm install express-formidable

the simple example is as follows

const express = require('express');
const formidable = require('express-formidable');
 
var app = express();
 
app.use(formidable());
 
app.post('/upload', (req, res) => {
  //req.fields contains non-file fields 
  //req.files contains files 
  res.send(JSON.stringify(req.fields));
});

Click here for further description

Solution 3

From the README of body-parser:

This does not handle multipart bodies, due to their complex and typically large nature.

The above is going to work with x-www-form-urlencoded and json but it will NOT work with any multipart. form-data is also multipart with the header multipart/form-data.

In case of form-data, your best solution would be to use express-formidable.

Solution 4

I noticed @HubballiHuli answer was to use a package called express-formidable. You don't need to use this unnecessary package, it provide one (small) file of code. Instead you can do it yourself (now removing the dependency).

Here is the formidableMiddleware file:

'use strict';

const formidable = require('formidable');

function parse(opts, events) {
  return (req, res, next) => {
    if (req.express_formidable && req.express_formidable.parsed) {
      next();
      return;
    }

    const form = new formidable.IncomingForm();
    Object.assign(form, opts);

    let manageOnError = false;
    if (events) {
      events.forEach((e) => {
        manageOnError = manageOnError || e.event === 'error';
        form.on(e.event, (...parameters) => { e.action(req, res, next, ...parameters); });
      });
    }

    if (!manageOnError) {
      form.on('error', (err) => {
        next(err);
      });
    }

    form.parse(req, (err, fields, files) => {
      if (err) {
        next(err);
        return;
      }

      Object.assign(req, { fields, files, express_formidable: { parsed: true } });
      next();
    });
  };
}

module.exports = parse;
exports.parse = parse;

Now on how to use it:

const express = require('express');
const formidableMiddleware = require('./formidableMiddleware.js');

var app = express();

app.use(formidableMiddleware());

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

I wrote an article on unnecessary packages a while ago and why not to use them: https://medium.com/@alexjamesdunlop/unnecessary-packages-b3623219d86

Solution 5

Besides the solutions with formidable, there is another module which I have been using in my recent projects since 2019. The module express-form-data can be easily declared in your server file like:

const express = require('express');
const formData = require('express-form-data');

app.use(formData.parse());

app.post('/image-upload', (req, res) => {
  console.log(req.files);
})

...

In case of image uploading, for instance, req.files will provide all relevant data you need for handling the files such as path, size, filename, etc.

View more solutions

Comments

[Jeremy]

This should not be downvoted. There really is no simple documentation for how to read a single POST parameter. The accepted solution uses a deprecated package.

[Dave Pile]

Jeremy I think that the accepted solution is not a deprecated package. The package Mritunjay refers to has a hyphen in its name and I believe is different to the "bodyparser" middleware that is vulnerable. I think it is referred to in some of the blog posts warning about the original "bodyparser". This is why I agree that it should not be downvoted (ie does not show any research effort) because I searched for ages for a solution but the problem is there is so much old and confusing information around it was doing my head in.

[Jeremy]

Thanks for the clarification; I didn't realize there was a difference between the body-parser and bodyParser packages. That subtlety is part of the reason this question is a proper one.

[Jeff]

in express 4, now use : app.use(bodyParser.urlencoded({ extended: true }));

[HubballiHuli]

@llamerr glad I could help.

[Khalid Taha]

me too, this worked for me, but the accepted answer did not.

[Phil]

You need to provide the extended option as there is no default in later versions of body-parser

[Alexander Kim]

Yes, but it won't work with FormData() which contains files.@stlia's answer is a good one.

[DileepNimantha]

Worked for me as well. Accepted answer didn't work with FormData() with files.

[Moritz]

in express 4.16, body-parser is now build in. you CAN use app.use(express.urlencoded({ extended: true }));