a body parser for koa, base on co-body.
Notice: koa-bodyparser@3
support koa@2
, if you want to use this module with koa@1
, please use koa-bodyparser@2
.
var bodyParser = require('koa-bodyparser');
var Koa = require('koa');
var app = new Koa();
app.use(bodyParser());
app.use(ctx => {
// the parsed body will store in this.request.body
// if nothing was parsed, body will be an empty object {}
ctx.body = ctx.request.body;
});
-
encode: requested encoding. Default is
utf-8
byco-body
-
formLimit: limit of the
urlencoded
body. If the body ends up being larger than this limit, a 413 error code is returned. Default is56kb
-
jsonLimit: limit of the
json
body. Default is1mb
-
strict: when set to true, JSON parser will only accept arrays and objects. Default is
true
. See strict mode inco-body
-
detectJSON: custom json request detect function. Default is
null
app.use(bodyparser({ detectJSON: function (ctx) { return /\.json$/i.test(ctx.path); } }));
-
extendTypes: support extend types:
app.use(bodyparser({ 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:app.use(bodyparser({ onerror: function (err, ctx) { ctx.throw('body parse error', 422); } }));