Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koajs/qs
qs for koa, and use querystring more safely.
https://github.com/koajs/qs
Last synced: 27 days ago
JSON representation
qs for koa, and use querystring more safely.
- Host: GitHub
- URL: https://github.com/koajs/qs
- Owner: koajs
- License: mit
- Created: 2013-12-19T10:06:39.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2020-05-27T06:21:36.000Z (over 4 years ago)
- Last Synced: 2024-04-14T13:08:40.667Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 22.5 KB
- Stars: 85
- Watchers: 6
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
- awesome-koa - qs - qs for koa, and use querystring more safely. (Middleware)
- awesome-koa - koa-qs - 支持嵌套的 query string。   (仓库 / 中间件)
README
# Koa Querystring
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![David deps][david-image]][david-url]
[![node version][node-image]][node-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/koa-qs.svg?style=flat-square
[npm-url]: https://npmjs.org/package/koa-qs
[travis-image]: https://img.shields.io/travis/koajs/qs.svg?style=flat-square
[travis-url]: https://travis-ci.org/koajs/qs
[coveralls-image]: https://img.shields.io/coveralls/koajs/qs.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/koajs/qs?branch=master
[david-image]: https://img.shields.io/david/koajs/qs.svg?style=flat-square
[david-url]: https://david-dm.org/koajs/qs
[node-image]: https://img.shields.io/badge/node.js-%3E=_8-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
[download-image]: https://img.shields.io/npm/dm/koa-qs.svg?style=flat-square
[download-url]: https://npmjs.org/package/koa-qs
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](https://github.com/ljharb/qs) support,
which is also used by Connect and Express.
Simply wrap a koa app with this module:
```js
// Koa 1.x.x
const koa = require('koa')
const app = koa()
require('koa-qs')(app)
// Koa 2.x.x
const Koa = require('koa')
const app = new Koa()
require('koa-qs')(app)
```
## Optional parse mode
There're three parse mode.
## `extended` mode
The default mode, use [qs] module.
```js
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`.
```js
require('koa-qs')(app, 'strict')
```
#### What's different
A normal request `GET /foo?p=a&q=foo&q=bar`.
- before patch
```js
console.log('%j', this.query);
{
"p": "a",
"q": ["foo", "bar"]
}
```
- after patch
```js
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.
```js
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](http://www.wooyun.org/bugs/wooyun-2010-086474)
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
```js
console.log('%j', this.query.p);
["a,b", "b,c"]
```
- after patch
```js
console.log('%j', this.query.p);
"a,b"
```
## License
[MIT](LICENSE)