https://github.com/chjj/parted

Streaming body parser for node.js.
https://github.com/chjj/parted

Last synced: 17 days ago
JSON representation

Streaming body parser for node.js.

• Host: GitHub
• URL: https://github.com/chjj/parted
• Owner: chjj
• License: mit
• Created: 2011-05-14T19:45:09.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2023-02-10T17:26:59.000Z (almost 2 years ago)
• Last Synced: 2024-10-20T01:14:51.742Z (24 days ago)
• Language: JavaScript
• Homepage:
• Size: 280 KB
• Stars: 63
• Watchers: 9
• Forks: 14
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# parted

Parted is a streaming multipart, json, and urlencoded parser for node.js,

written from scratch. It comes bundled with an express middleware which

will use the necessary parser depending on the request mime type. Each parser

is also lazily loaded, so there is no unnecessary memory usage if you only need

one of them.

The middleware will leave you with a `req.body` object, similar to the default

body parser included in express. If a file was included with a multipart

request, a temporary path to the uploaded file is provided in `req.body`.

The multipart parser will also create a `req.files` object specifically for

files if you prefer.

Every parser handles nested fields in the same way `node-querystring` does.

*Note;* Although the JSON and qs/encoded parsers are streaming, they're disabled

by default and buffering parsers are used instead. Use the `stream` option to

enable them.

## Install

``` bash

$ npm install parted

```

## As a middleware

``` js

var parted = require('parted');

app.use(parted({

  // custom file path

  path: __dirname + '/uploads',

  // memory usage limit per request

  limit: 30 * 1024,

  // disk usage limit per request

  diskLimit: 30 * 1024 * 1024,

  // enable streaming for json/qs

  stream: true

}));

```

When `multiple` is disabled only a single part will be present

for a given name, for example:

```js

{ image: '/tmp/bigred.1319577761529.png' }

```

However when `multiple` is enabled, this _may_ be an array:

```js

{ images:

   [ '/tmp/bigred-pau.1319577761529.png',

     '/tmp/bigred-ico.1319577761528.png',

     '/tmp/bigred-rec.1319577761529.png',

     '/tmp/bigred-sto.1319577761529.png',

     '/tmp/bigred.1319577761529.png' ] }

```

## Usage

### The multipart parser alone

``` js

var multipart = require('parted').multipart;

var options = {

  limit: 30 * 1024,

  diskLimit: 30 * 1024 * 1024

};

var parser = new multipart(type, options)

  , parts = {};

parser.on('error', function(err) {

  req.destroy();

  next(err);

});

parser.on('part', function(field, part) {

  // temporary path or string

  parts[field] = part;

});

parser.on('data', function() {

  console.log('%d bytes written.', this.written);

});

parser.on('end', function() {

  console.log(parts);

});

req.pipe(parser);

```

## Running tests

    $ node test