a body parser for koa
Last updated a year ago by dead_horse .
MIT · Repository · Bugs · Original npm · Tarball
$ cnpm install koa-bodyparser 
SYNC missed versions from official npm registry.


NPM version build status Coveralls David deps node version Gittip

A body parser for koa, base on co-body. support json, form and text type body.




var Koa = require('koa');
var bodyParser = require('koa-bodyparser');

var app = new Koa();

app.use(async ctx => {
  // the parsed body will store in ctx.request.body
  // if nothing was parsed, body will be an empty object {}
  ctx.body = ctx.request.body;


  • enableTypes: parser will only parse when request type hits enableTypes, default is ['json', 'form'].

  • 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.

  • textLimit: limit of the text 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. In strict mode, ctx.request.body will always be an object(or array), this avoid lots of type judging. But text body will always return string type.

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

      detectJSON: function (ctx) {
        return /\.json$/i.test(ctx.path);
  • extendTypes: support extend types:

      extendTypes: {
        json: ['application/x-javascript'] // will parse application/x-javascript type body as a JSON string
  • onerror: support custom error handle, if koa-bodyparser throw an error, you can customize the response like:

      onerror: function (err, ctx) {
        ctx.throw('body parse error', 422);
  • disableBodyParser: you can dynamic disable body parser by set ctx.disableBodyParser = true.

app.use(async (ctx, next) => {
  if (ctx.path === '/disable') ctx.disableBodyParser = true;
  await next();

Raw Body

You can access raw request body by ctx.request.rawBody after koa-bodyparser when:

  1. koa-bodyparser parsed the request body.
  2. ctx.request.rawBody is not present before koa-bodyparser.

Koa 1 Support

To use koa-bodyparser with koa@1, please use bodyparser 2.x.

npm install koa-bodyparser@2 --save



Maintainers (2)
Today 577
This Week 4,793
This Month 24,019
Last Day 1,409
Last Week 8,178
Last Month 21,946
Dependencies (2)
Dev Dependencies (6)
Dependents (687)

Copyright 2014 - 2017 © taobao.org |