co-multipart

Download multipart files with open file descriptor limits and file disposal

npm install co-multipart
1 downloads in the last day
13 downloads in the last week
36 downloads in the last month

co multipart

A busboy-based multipart parser using co or koa that saves files to disk. Use this instead of co-busboy if you want to just download the files to disk and don't care about validating the fields before the downloading the files (i.e. validating the CSRF token).

  • Open file descriptor limit - throttle the request so you don't use too many file descriptors!
  • Easy disposal - automatically deletes all the files if the request is aborted (i.e. closed before finished parsing). Returns a .dispose() method to easily delete all the files yourself whenever you like.

API

var multipart = require('co-multipart')

app.use(function* (next) {
  var parts = yield* multipart(this)

  // do stuff with the body parts
  parts.files.forEach(function (file) {

  })

  // delete all the files when you're done
  parts.dispose()
})

var parts = yield* multipart(request, [options])

request can be a raw node HTTP req or a Koa context. options, other than those passed to busboy, are:

  • concurrency: 2 - Maximum number of open file descriptors.

parts.field, parts.fields

parts.field is an object to look up objects via name. Ex. var token = parts.field._csrf. parts.fields is an array with all fields as an array with the values:

0. `fieldname`
1. `value`
2. `valueTruncated` - `Boolean`
3. `fieldnameTruncated` - Boolean

parts.file, parts.files

parts.file is an object to look up files via name. parts.files is an array with all the files. Each file is a Readable Stream with the properties:

- `path` - where this file was saved
- `fieldname`
- `filename` - according to the client
- `transferEncoding` or `encoding`
- `mimeType` or `mime`

parts.path

The temporary folder in which all the files are saved.

parts.dispose()

Deletes all the files in this multipart request.

License

The MIT License (MIT)

Copyright (c) 2013 Jonathan Ong me@jongleberry.com

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.

npm loves you