Are you happy with your logging solution? Would you help us out by taking a 30-second survey? Click here

bodyparser

a body parser for koa

Subscribe to updates I use bodyparser


Statistics on bodyparser

Number of watchers on Github 588
Number of open issues 6
Average time to close an issue 8 days
Main language JavaScript
Average time to merge a PR about 14 hours
Open pull requests 4+
Closed pull requests 10+
Last commit about 2 years ago
Repo Created over 5 years ago
Repo Last Updated over 1 year ago
Size 77 KB
Organization / Authorkoajs
Contributors8
Page Updated
Do you use bodyparser? Leave a review!
View open issues (6)
View bodyparser activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating bodyparser for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

koa-bodyparser

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.

Install

NPM

Usage

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

var app = new Koa();
app.use(bodyParser());

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

Options

  • 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.
  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);
    }
  }));
  • 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();
});
app.use(bodyparser());

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

Licences

MIT

bodyparser open issues Ask a question     (View All Issues)
  • about 3 years post array more than 21
  • about 3 years Verify function just like body-parser
  • about 3 years Bodyparser causing 404 error if `await` is not used with `next` in any previous middleware
  • over 4 years same problem like koa-qs#1
  • over 5 years auto charset decoding support
bodyparser open pull requests (View All Pulls)
  • add plain text support
  • Remove harmony flags in Makefile for v3.x
  • Let's add ability to parse content type `multipart/form-data`
  • Support Content-Type application/jwt
bodyparser questions on Stackoverflow (View All Questions)
  • express4 bodyparser post array item is udefined
  • Node.js (with express & bodyParser): unable to obtain form-data from post request
  • Parsing JSON in Express without BodyParser
  • Error: Can't set headers after they are sent (without express and bodyparser)
  • Sails.js change bodyParser for specific paths
  • mean.io - Error: 'Request entity too large'. How to increase bodyParser limit outside meanio module?
  • Rendering to html file with express and bodyparser
  • Scala Play - Action.async with BodyParser - Exception Handling
  • Unable to post via express using bodyparser
  • How to decode image in node js with using bodyparser
  • why node.js bodyParser always returns 'undefined'?
  • How does bodyParser know which view to populate in to req.body?
  • bodyParser is deprecated express 4
  • The bodyParser not work when post "form-data" with POSTMAN
  • Expressjs module bodyparser returns undefined
  • Express 4 bodyParser variable blocking methodOverride
  • trying to use both bodyParser and busboy using nodejs
  • Express bodyParser cannot parse data coming from Internet Explorer
  • Consuming JSON using Express 4.11 and bodyParser
  • node.js express bodyParser POST limit
  • Node js : Using Handlebars and Bodyparser together
  • BodyParser sends undefined when reading form
  • node.js architecture - how to share middleware (bodyparser)
  • BodyParser parse data instead of connect-multiparty in node.js
  • How would you access form data without using bodyParser?
  • express.js 4: catch bodyParser error in router's errorHandler
  • BodyParser doesn't recognise input
  • I have one issue in nodejs. I can´t add the middleware BodyParser
  • Error: Most middleware (like bodyParser) is no longer bundled with Express
  • Syntax error at Object.parse when making a request, using Node, Bodyparser, and MongoDB
bodyparser list of languages used
Other projects in JavaScript