andela-koa-body

koa-body

A full-featured koa body parser middleware. Support multipart, urlencoded and json request bodies. Provides same functionality as Express's bodyParser - multer. And all that is wrapped only around co-body and formidable.

Install

Install with npm

$ npm install koa-body

Legacy Koa v1 support

$ npm install koa-body@3

Breaking Changes in v3/4

To address a potential security issue, the files property has been moved to ctx.request.files. In prior versions, files was a property of ctx.request.body. If you do not use multipart uploads, no changes to your code need to be made.

Versions 1 and 2 of koa-body are deprecated and replaced with versions 3 and 4, respectively.

Features

• can handle three type requests
  • multipart/form-data
  • application/x-www-urlencoded
  • application/json
• option for patch to Koa or Node, or either
• file uploads
• body, fields and files limiting

Hello world

npm install koa
npm install koa-body
nvm install v8.11.2 # Note - Koa requires node v7.6.0+ for async/await support

index.js:

const Koa = require('koa');
const koaBody = require('koa-body');

const app = new Koa();

app.use(koaBody());
app.use(ctx => {
  ctx.body = `Request Body: ${JSON.stringify(ctx.request.body)}`;
});

app.listen(3000);

$ node index.js
$ curl -i http://localhost:3000/users -d "name=test"
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
Content-Length: 29
Date: Wed, 03 May 2017 02:09:44 GMT
Connection: keep-alive

Request Body: {"name":"test"}%

For a more comprehensive example, see examples/multipart.js

Usage with koa-router

It's generally better to only parse the body as needed, if using a router that supports middleware composition, we can inject it only for certain routes.

const Koa = require('koa');
const app = new Koa();
const router = require('koa-router')();
const koaBody = require('koa-body');

router.post('/users', koaBody(),
  (ctx) => {
    console.log(ctx.request.body);
    // => POST body
    ctx.body = JSON.stringify(ctx.request.body);
  }
);

app.use(router.routes());

app.listen(3000);
console.log('curl -i http://localhost:3000/users -d "name=test"');

Options

Options available for koa-body. Four custom options, and others are from raw-body and formidable.

• patchNode {Boolean} Patch request body to Node's ctx.req, default false
• patchKoa {Boolean} Patch request body to Koa's ctx.request, default true
• jsonLimit {String|Integer} The byte (if integer) limit of the JSON body, default 1mb
• formLimit {String|Integer} The byte (if integer) limit of the form body, default 56kb
• textLimit {String|Integer} The byte (if integer) limit of the text body, default 56kb
• encoding {String} Sets encoding for incoming form fields, default utf-8
• multipart {Boolean} Parse multipart bodies, default false
• urlencoded {Boolean} Parse urlencoded bodies, default true
• text {Boolean} Parse text bodies, default true
• json {Boolean} Parse json bodies, default true
• jsonStrict {Boolean} Toggles co-body strict mode; if set to true - only parses arrays or objects, default true
• returnRawBody {Boolean} Toggles co-body returnRawBody option; if set to true, for requests of type 'application/x-www-form-urlencoded, the object returned will be { parsed: parsed value, raw: raw body}, where the key parsed will contain the parsed and the key raw will contain the raw urlencoded form parameters string, default false
• formidable {Object} Options to pass to the formidable multipart parser
• onError {Function} Custom error handle, if throw an error, you can customize the response - onError(error, context), default will throw
• strict {Boolean} If enabled, don't parse GET, HEAD, DELETE requests, default true

A note about strict mode

see http://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-19#section-6.3

• GET, HEAD, and DELETE requests have no defined semantics for the request body, but this doesn't mean they may not be valid in certain use cases.
• koa-body is strict by default

Some options for formidable

See node-formidable for a full list of options

• maxFields {Integer} Limits the number of fields that the querystring parser will decode, default 1000
• maxFieldsSize {Integer} Limits the amount of memory all fields together (except files) can allocate in bytes. If this value is exceeded, an 'error' event is emitted, default 2mb (2 * 1024 * 1024)
• uploadDir {String} Sets the directory for placing file uploads in, default os.tmpDir()
• keepExtensions {Boolean} Files written to uploadDir will include the extensions of the original files, default false
• hash {String} If you want checksums calculated for incoming files, set this to either 'sha1' or 'md5', default false
• multiples {Boolean} Multiple file uploads or no, default true
• onFileBegin {Function} Special callback on file begin. The function is executed directly by formidable. It can be used to rename files before saving them to disk. See the docs

Note: You can patch request body to Node or Koa in same time if you want.

Tests

$ npm test

License

The MIT License, 2014 Charlike Mike Reagent (@tunnckoCore) and Daryl Lau (@daryllau)