koa-bodyparser

a body parser for koa, base on co-body.

Install

Usage

1var koa = require('koa');
2var bodyParser = require('koa-bodyparser');
3
4var app = koa();
5app.use(bodyParser());
6
7app.use(function *() {
8  // the parsed body will store in this.request.body
9  // if nothing was parsed, body will be an empty object {}
10  this.body = this.request.body;
11});

Options

• encode: requested encoding. Default is utf-8 by co-body

• formLimit: limit of the urlencoded body. If the body ends up being larger than this limit, a 413 error code is returned. Default is 56kb

• jsonLimit: limit of the json body. Default is 1mb

• strict: when set to true, JSON parser will only accept arrays and objects. Default is true. See strict mode in co-body

• detectJSON: custom json request detect function. Default is null

  1app.use(bodyparser({
  2  detectJSON: function (ctx) {
  3    return /\.json$/i.test(ctx.path);
  4  }
  5}));

• extendTypes: support extend types:

  1app.use(bodyparser({
  2  extendTypes: {
  3    json: ['application/x-javascript'] // will parse application/x-javascript type body as a JSON string
  4  }
  5}));

• onerror: support custom error handle, if koa-bodyparser throw an error, you can customize the response like:

  1app.use(bodyparser({
  2  onerror: function (err, ctx) {
  3    ctx.throw('body parse error', 422);
  4  }
  5}));

Licences

MIT