# parse-prefer-header

> parses an http prefer header, aka rfc7240

Latest version **1.0.0** (published 2016-11-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install parse-prefer-header
pnpm add parse-prefer-header
yarn add parse-prefer-header
bun add parse-prefer-header
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-11-26 |
| First published | 2016-11-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/parse-prefer-header) |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Patrick Paskaris |
| Maintainers | ppaskaris |
| Keywords | prefer, rfc7240, 7240 |

## Links

- npm: https://www.npmjs.com/package/parse-prefer-header
- Repository: https://github.com/ppaskaris/node-parse-prefer-header
- Homepage: https://github.com/ppaskaris/node-parse-prefer-header#readme
- Issues: https://github.com/ppaskaris/node-parse-prefer-header/issues
- npm.io page: https://npm.io/package/parse-prefer-header

## Dependencies (1)

- [lodash.camelcase](https://npm.io/package/lodash.camelcase.md) ^4.3.0

## Recent versions

- 1.0.0 (latest) — 2016-11-26

## README

# node-parse-prefer-header

Parses an HTTP `Prefer` header, aka
[RFC7240](https://tools.ietf.org/html/rfc7240).

```js
const parsePreferHeader = require('parse-prefer-header');

const preferences = parsePreferHeader('respond-async, wait=300');
// preferences = { respondAsync: true, wait: '300' }
```

## Installation

```
$ npm install parse-prefer-header
```

## Features

- Parses the HTTP `Prefer` header into a friendly JavaScript object
- Normalizes tokens into JavaScript properties (e.g. `respondAsync`)
- Handles quoting correctly (e.g. `foo=";= ,;="` becomes `{ foo: ';= ,;='}`)
- Supports token parameters

## API

```typescript
parsePreferHeader(preferHeader: string | string[]): { [key: string]: string | boolean }
```

Parses the Prefer header value, or an Array of such values, and returns an
object mapping each preference token to its value or `true`.

See [here](https://tools.ietf.org/html/rfc7240#section-4) for an explanation of
the initial set of preferences.

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