koa-bodyparser
Advanced tools
Package description
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.
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);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 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 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
A body parser for koa, based on co-body. support json, form and text type body.
Notice: this module doesn't support parsing multipart format data, please use
@koa/multerto parse multipart format data.
const Koa = require('koa');
const bodyParser = require('koa-bodyparser');
const 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;
});
enableTypes: parser will only parse when request type hits enableTypes, support json/form/text/xml, default is ['json', 'form'].
encoding: 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.
xmlLimit: limit of the xml 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(422, 'body parse error');
}
}));
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());
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 before koa-bodyparser.To use koa-bodyparser with koa@1, please use bodyparser 2.x.
npm install koa-bodyparser@2 --save
FAQs
a body parser for Koa
The npm package koa-bodyparser receives a total of 449,141 weekly downloads. As such, koa-bodyparser popularity was classified as popular.
We found that koa-bodyparser demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The US Justice Department has penalized two consulting firms $11.3 million for failing to meet cybersecurity requirements on federally funded projects, emphasizing strict enforcement to protect sensitive government data.
Security News
ua-parser-js is set to drop the MIT license and adopt a controversial dual AGPLv3 + PRO licensing model in its upcoming v2.0 release, raising significant concerns among developers and enterprise users.
Security News
Researchers recently demonstrated that the npm Registry is vulnerable to cache poisoning combined with DoS, posing significant risks for package availability.