Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including koa-qs with all npm packages installed. Try it out:

var koaQs = require("koa-qs")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

koa-qs v2.0.0

qs for koa

Koa Querystring

NPM version build status Test coverage David deps iojs version node version npm download

By default, Koa uses the native querystring module which does not provide nesting support. This patches a koa app with nesting support via the qs support, which is also used by Connect and Express.

Simply wrap a koa app with this module:

var koa = require('koa')
var app = koa()
require('koa-qs')(app)

Optional parse mode

There're three parse mode.

extended mode

The default mode, use qs module.

require('koa-qs')(app, 'extended')

simple mode

Use querystring module, same as koa does by default. If you want to use this mode, don't use this module.

strict mode

This mode make this.query.foo return strict array.

require('koa-qs')(app, 'strict')

What's different

A normal request GET /foo?p=a&q=foo&q=bar.

  • before patch
console.log('%j', this.query);
{
  "p": "a",
  "q": ["foo", "bar"]
}
  • after patch
console.log('%j', this.query);
{
  "p": ["a"],
  "q": ["foo", "bar"]
}

first mode

This mode make this.query.foo return strict string. Disable multi values.

If querystring contains multi same name params, return the first item.

require('koa-qs')(app, 'first')

In 95% use cases, application only want string query params.

This patch can avoid some stupid TypeError and some security issues like MongoDB inject when the developers forget handling query params type check.

What's different

A normal request GET /foo?p=a,b&p=b,c.

  • before patch
console.log('%j', this.query.p);
["a,b", "b,c"]
  • after patch
console.log('%j', this.query.p);
"a,b"

License

MIT

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free