koa-bodyparser-secure

3.0.0 • Public • Published

koa-bodyparser

NPM version build status Coveralls David deps node version Gittip

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

Install

NPM

Usage

var koa = require('koa');
var bodyParser = require('koa-bodyparser');
 
var app = koa();
app.use(bodyParser());
 
app.use(function *() {
  // the parsed body will store in this.request.body
  // if nothing was parsed, body will be an empty object {}
  this.body = this.request.body;
});

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

    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);
      }
    }));

Licences

MIT

Package Sidebar

Install

npm i koa-bodyparser-secure

Weekly Downloads

0

Version

3.0.0

License

MIT

Last publish

Collaborators

  • ptariche