# @davidov541/multipart-form-parser

> A javascript/nodejs multipart/form-data parser which operates on raw data.

Latest version **1.1.1** (published 2020-07-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @davidov541/multipart-form-parser
pnpm add @davidov541/multipart-form-parser
yarn add @davidov541/multipart-form-parser
bun add @davidov541/multipart-form-parser
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2020-07-26 |
| First published | 2020-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | David McGinnis |
| Maintainers | mcginnda |
| Keywords | multipart/form-data, form, fileuploader |

## Links

- npm: https://www.npmjs.com/package/@davidov541/multipart-form-parser
- Repository: https://github.com/davidov541/multipart-form-parser
- Issues: https://github.com/davidov541/multipart-form-parser/issues
- npm.io page: https://npm.io/package/@davidov541/multipart-form-parser

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2020-07-26
- 1.1.0 — 2020-07-26
- 1.0.5 — 2020-07-26
- 1.0.4 — 2020-07-25
- 1.0.3 — 2020-07-25
- 1.0.1 — 2020-07-25

## README

# multipart-form-parser

A javascript/nodejs multipart/form-data parser which operates on raw data.

# Author
David McGinnis (mcginnda@davidmcginnis.net)

# Background

Sometimes you only have access to the raw multipart payload and it needs to be
parsed in order to extract the files or data contained on it. As an example: 
the Amazon AWS ApiGateway, which will operate as a facade between the http
client and your component (the one written by you designed to extract the 
uploaded files or data). 

The raw payload formatted as multipart/form-data will looks like this one:

```
------WebKitFormBoundaryDtbT5UpPj83kllfw
Content-Disposition: form-data; name="uploads[]"; filename="somebinary.dat"
Content-Type: application/octet-stream

some binary data...maybe the bits of a image..
------WebKitFormBoundaryDtbT5UpPj83kllfw
Content-Disposition: form-data; name="uploads[]"; filename="sometext.txt"
Content-Type: text/plain

hello how are you
------WebKitFormBoundaryDtbT5UpPj83kllfw--
```

The lines above represents a raw multipart/form-data payload sent by some 
HTTP client via form submission containing two files. We need to extract the 
all files contained inside it. The multipart format allows you to send more 
than one file in the same payload, that's why it is called: multipart.

# Usage

In the next lines you can see a implementation. In this case two key values
needs to be present:

* body, which can be:

```
------WebKitFormBoundaryDtbT5UpPj83kllfw
Content-Disposition: form-data; name="uploads[]"; filename="sometext.txt"
Content-Type: application/octet-stream

hello how are you
------WebKitFormBoundaryDtbT5UpPj83kllfw--
```

* boundary, the string which serve as a 'separator' between parts, it normally
comes to you via headers. In this case, the boundary is:

```
	----WebKitFormBoundaryDtbT5UpPj83kllfw
```

Now, having this two key values then you can implement it:

```
	var multipart = require('parse-multipart');
	var body = "..the multipart raw body..";
	var boundary = "----WebKitFormBoundaryDtbT5UpPj83kllfw";
	var parts = multipart.Parse(body,boundary);
	
	for(var i=0;i<parts.length;i++){
		var part = parts[i];
		// will be:
		// { filename: 'A.txt', type: 'text/plain', 
		//		data: <Buffer 41 41 41 41 42 42 42 42> }
	}
```

The returned data is an array of parts, each one described by a filename,
a type and a data, this last one is a Buffer (see also Node Buffer).

---
_Source: https://npm.io/package/@davidov541/multipart-form-parser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._