body-parser - extended option (qs vs querystring)

c.. picture c.. · Mar 20, 2015 · Viewed 11.4k times · Source

In the current version of body-parser, the extended option when using bodyParser.urlencoded() is now required. In the README, it explains:

The extended option allows to choose between parsing the URL-encoded data with the querystring library (when false) or the qs library (when true).

[...]

Defaults to true, but using the default has been deprecated. Please research into the difference between qs and querystring and choose the appropriate setting.

I couldn't find any helpful or specific information on this. I only found a deprecated node-querystring.

Should this option just always be true?

Answer

Leonid Beschastny picture Leonid Beschastny · Mar 21, 2015

The reason for this message is that body-parser is about to change default value for extended from true to false.

Extended protocol uses qs library to parse x-www-form-urlencoded data. The main advantage of qs is that it uses very powerful serialization/deserialization algorithm, capable of serializing any json-like data structure.

But web-browsers don't normally use this protocol, because x-www-form-urlencoded was designed to serialize flat html forms. Though, it may come in handy if you're going to send rich data structures using ajax.

querystring library` provides basic serialization/deserialization algorithm, the one used by all web-browsers to serialize form data. This basic algorithm is significantly simpler than extended one, but limited to flat data structures.

Both algorithms work exactly the same with flat data.

Now, when you know pros and cons of both algorithms, it's up to you to decide which one suits your application better.