koa-bodyparser

What is koa-bodyparser?

koa-bodyparser is a middleware for Koa that parses incoming request bodies in a middleware before your handlers, making it available under the `ctx.request.body` property. It supports parsing JSON, form, and text bodies.

What are koa-bodyparser's main functionalities?

JSON Body Parsing

This feature allows you to parse JSON bodies from incoming requests. The parsed data is available on `ctx.request.body`.

const Koa = require('koa');
const bodyParser = require('koa-bodyparser');
const app = new Koa();

app.use(bodyParser());

app.use(async ctx => {
  if (ctx.method === 'POST') {
    ctx.body = `Received JSON data: ${JSON.stringify(ctx.request.body)}`;
  } else {
    ctx.body = 'Send a POST request with JSON data';
  }
});

app.listen(3000);

Form Body Parsing

This feature allows you to parse URL-encoded form bodies from incoming requests. The parsed data is available on `ctx.request.body`.

const Koa = require('koa');
const bodyParser = require('koa-bodyparser');
const app = new Koa();

app.use(bodyParser());

app.use(async ctx => {
  if (ctx.method === 'POST') {
    ctx.body = `Received form data: ${JSON.stringify(ctx.request.body)}`;
  } else {
    ctx.body = 'Send a POST request with form data';
  }
});

app.listen(3000);

Text Body Parsing

This feature allows you to parse plain text bodies from incoming requests. The parsed data is available on `ctx.request.body`.

const Koa = require('koa');
const bodyParser = require('koa-bodyparser');
const app = new Koa();

app.use(bodyParser({ enableTypes: ['text'] }));

app.use(async ctx => {
  if (ctx.method === 'POST') {
    ctx.body = `Received text data: ${ctx.request.body}`;
  } else {
    ctx.body = 'Send a POST request with text data';
  }
});

app.listen(3000);

Other packages similar to koa-bodyparser

koa-body

koa-body is a more feature-rich alternative to koa-bodyparser. It supports file uploads, multiple body types (JSON, form, text), and can handle multipart requests. It is more versatile but also more complex to configure compared to koa-bodyparser.

koa-multer

koa-multer is a middleware for handling multipart/form-data, which is primarily used for uploading files. It is similar to koa-bodyparser but focuses on file uploads and does not handle JSON or URL-encoded form bodies.

koa-json-body

koa-json-body is a simpler alternative that focuses solely on parsing JSON bodies. It is less versatile than koa-bodyparser but can be a good choice if you only need to handle JSON data.

README

koa-body-parser

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

Install

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
  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
• extendTypes: support extend types:

app.use(bodyparser({
  extendTypes: {
    json: ['application/x-javascript'] // will parse application/x-javascript type body as a JSON string
  }
}));

Licences

(The MIT License)

Copyright (c) 2014 dead-horse and other contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.