npm

Need private packages and team management tools?Check out npm Orgs. »

koa-json

2.0.2 • Public • Published

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:

var json = require('koa-json');
var Koa = require('koa');
var app = new Koa();
 
app.use(json());
 
app.use((ctx) => {
  ctx.body = { foo: 'bar' };
});

yields:

GET /
 
{
  "foo": "bar"
}

Default to being disabled (useful in production), but togglable via the query-string parameter:

var Koa = require('koa');
var app = new Koa();
 
app.use(json({ pretty: false, param: 'pretty' }));
 
app.use((ctx) => {
  ctx.body = { foo: 'bar' };
});

yields:

GET /
 
{"foo":"bar"}
GET /?pretty
 
{
  "foo": "bar"
}

License

MIT

Keywords

install

npm i koa-json

Downloadsweekly downloads

23,206

version

2.0.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability