Ragg-
More short API for koa-better-body.
A koa body parser middleware with support for
multipart,json,csp-reportandurlencodedrequest bodies. Viaformidableandco-better-body. It's fork ofkoa-better-body
Install
npm i --save koa-short-body
npm testUsage
examples/multer- usage like Express's bodyParser - multernpm run examples-multerexamples/koa-router- usage with Alex's koa-routernpm run examples-koa-router
Extending default types
Every new defined type, will be appended to defaults, see defaults
app.use(koaBody({
extendTypes: {
// will parse application/x-javascript type body as a JSON string
json: ['application/x-javascript'],
multipart: ['multipart/mixed']
}
}));will expects request bodies
application/json
application/json-patch+json
application/vnd.api+json
application/csp-report
application/x-javascript
application/x-www-form-urlencoded
multipart/form-data
multipart/mixedget field or file via this
app.use(function * (next) {
// Get specify fields
console.log(this.field("field_name"));
// Get received all fields.
console.log(this.field());
// Get specify fields file (it's must be returns Array<File>)
console.log(this.file("file"));
// Get all received files
console.log(this.file());
}).koaBetterBody
However,
koa-short-bodyhave few custom options, see also co-better-body, raw-body and formidable
[options]{Object}jsonLimit{String|Number} The byte limit of the JSON body, default1mbformLimit{String|Number} The byte limit of the form body, default56kbencoding{String} Sets encoding for incoming form fields, defaultutf-8encode{String} alias ofopts.encodingmultipart{Boolean} Supportmultipart/form-datarequest bodies, defaultfalseextendTypes{Object} extending request types, see defaultsmultipart{Array} array with multipart types, default['multipart/form-data']json{Array} array with json types, default['application/x-www-form-urlencoded']form{Array} array with form types
qs{Object} Options that are passing to qsformidable{Object} Options that are passing toformidableformidable.maxFields{Number} See formidable-options. our default10formidable.multiples{Boolean} See formidable-options, our defaulttrueformidable.keepExtensions{Boolean} See formidable-options, our defaulttrue
return{GeneratorFunction} That you can use with koa or co
formidable options
See node-formidable for a full list of options
bytesExpected{Integer} The expected number of bytes in this form, defaultnullmaxFields{Integer} Limits the number of fields that the querystring parser will decode, default1000maxFieldsSize{Integer} Limits the amount of memory a field can allocate in bytes, default2mbuploadDir{String} Sets the directory for placing file uploads in, defaultos.tmpDir()hash{String} If you want checksums calculated for incoming files -'sha1'or'md5', defaultfalsemultiples{Boolean} Multiple file uploads or no, defaultfalse
qs options
See qs for a full list of options
depth{Integer} The parsed object maximum hierarchy depth, default5delimiter{String|Regex} The query string delimeter, default&arrayLimit{Integer} Maximum array size or -1 to disable arrays, default20
Author
Charlike Mike Reagent
- gratipay/tunnckoCore
- twitter/tunnckoCore
- github/tunnckoCore
- npmjs/tunnckoCore
koa-short-bodymaked by twitter/_ragg_
License 
Copyright (c) 2014-2015 Charlike Mike Reagent, contributors.
Released under the MIT license.
Powered and automated by kdf, February 6, 2015