koa-json
Version:
pretty (non-compressed) json response middleware
78 lines (52 loc) • 930 B
Markdown
# koa-json
JSON pretty-printed response middleware.
Also converts node object streams to binary.
## Installation
```
$ npm install koa-json
```
## Options
- `pretty` default to pretty response [true]
- `param` optional query-string param for pretty responses [none]
- `spaces` JSON spaces [2]
## Example
Always pretty by default:
```js
var json = require('koa-json');
var Koa = require('koa');
var app = new Koa();
app.use(json());
app.use((ctx) => {
ctx.body = { foo: 'bar' };
});
```
yields:
```js
$ GET /
{
"foo": "bar"
}
```
Default to being disabled (useful in production), but
togglable via the query-string parameter:
```js
var Koa = require('koa');
var app = new Koa();
app.use(json({ pretty: false, param: 'pretty' }));
app.use((ctx) => {
ctx.body = { foo: 'bar' };
});
```
yields:
```js
$ GET /
{"foo":"bar"}
```
```js
$ GET /?pretty
{
"foo": "bar"
}
```
# License
MIT