koa-bodyparser
A body parser for koa, base on co-body. support json
, form
and text
type body.
Install
Usage
var Koa = ;var bodyParser = ; var app = ;app; app;
Options
-
enableTypes: parser will only parse when request type hits enableTypes, default is
['json', 'form']
. -
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
. -
textLimit: limit of the
text
body. Default is1mb
. -
strict: when set to true, JSON parser will only accept arrays and objects. Default is
true
. See strict mode inco-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
.app; -
extendTypes: support extend types:
app; -
onerror: support custom error handle, if
koa-bodyparser
throw an error, you can customize the response like:app; -
disableBodyParser: you can dynamic disable body parser by set
ctx.disableBodyParser = true
.
app;app;
Raw Body
You can access raw request body by ctx.request.rawBody
after koa-bodyparser
when:
koa-bodyparser
parsed the request body.ctx.request.rawBody
is not present beforekoa-bodyparser
.
Koa 1 Support
To use koa-bodyparser
with koa@1, please use bodyparser 2.x.
npm install koa-bodyparser@2 --save