# content-disposition-parser

> Parse Content-Disposition HTTP header. No dependencies, no errors, just parse.

Latest version **1.0.2** (published 2022-06-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install content-disposition-parser
pnpm add content-disposition-parser
yarn add content-disposition-parser
bun add content-disposition-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.0.2 |
| Published | 2022-06-22 |
| First published | 2022-06-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10 |
| Dependencies | 0 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Yurk Sha |
| Maintainers | yurk |
| Keywords | content-disposition, header, parser, http, express, res, js, node, browser, js |

## Links

- npm: https://www.npmjs.com/package/content-disposition-parser
- Repository: https://github.com/yurks/content-disposition-parser
- Homepage: https://github.com/yurks/content-disposition-parser#readme
- Issues: https://github.com/yurks/content-disposition-parser/issues
- npm.io page: https://npm.io/package/content-disposition-parser

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.2 (latest) — 2022-06-22

## README

# content-disposition-parser

[![GitHub release](https://img.shields.io/github/release/yurks/content-disposition-parser.svg)](https://github.com/yurks/content-disposition-parser/releases/)
[![Build Status](https://travis-ci.org/yurks/content-disposition-parser.svg?branch=main)](https://travis-ci.org/yurks/content-disposition-parser)
[![Coverage Status](https://coveralls.io/repos/github/yurks/content-disposition-parser/badge.svg)](https://coveralls.io/github/yurks/content-disposition-parser)
[![GitHub license](https://img.shields.io/github/license/yurks/content-disposition-parser.svg)](https://github.com/yurks/content-disposition-parser/blob/master/LICENSE)

Tiny and fully-tested JS parser for Content-Disposition HTTP header with zero dependencies for nodejs and browser environments.

This library parses a header string, constructing the object with properties it could extract.
No validations, no conversions (except decodeURIComponent()) just an attempt to extract data as it is and as lot as possible.

## Installation

```sh
$ npm install content-disposition-parser
```

## Usage

```js
const parser = require('content-disposition-parser')

parser('content-disposition: inline; filename=example.pdf')
//-> { filename: 'example.pdf', type: 'inline' }

parser('content-disposition: form-data; name="field2"; filename="example.txt"')
//-> { filename: 'example.txt', name: 'field2', type: 'form-data' }

parser("Inline; filename=example.txt; FileName*=ISO-8859-1'en'%C3%A9xampl%C3%A9.txt")
//-> { encoding: 'iso-8859-1', filename: 'éxamplé.txt', type: 'inline' }
```

For more examples check [detailed test cases](test/snapshots/parser.js.md).

## License

[MIT](LICENSE)

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