# forwarded-parse

> Parse the Forwarded header (RFC 7239) into an array of objects

Latest version **2.1.2** (published 2021-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install forwarded-parse
pnpm add forwarded-parse
yarn add forwarded-parse
bun add forwarded-parse
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.2 |
| Published | 2021-11-03 |
| First published | 2015-06-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Luigi Pinca |
| Maintainers | lpinca |
| Keywords | forwarded, RFC-7239, rfc-7239, RFC7239, rfc7239, header, parser, 7239, RFC, rfc |

## Links

- npm: https://www.npmjs.com/package/forwarded-parse
- Repository: https://github.com/lpinca/forwarded-parse
- Issues: https://github.com/lpinca/forwarded-parse/issues
- npm.io page: https://npm.io/package/forwarded-parse

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 2.1.2 (latest) — 2021-11-03
- 2.1.1 — 2020-11-26
- 2.1.0 — 2018-01-12
- 2.0.0 — 2016-08-29
- 1.0.1 — 2015-06-06
- 1.0.0 — 2015-06-04

## README

# forwarded-parse

[![Version npm][npm-forwarded-parse-badge]][npm-forwarded-parse]
[![Build Status][ci-forwarded-parse-badge]][ci-forwarded-parse]
[![Coverage Status][coverage-forwarded-parse-badge]][coverage-forwarded-parse]

Parse the `Forwarded` header ([RFC 7239][rfc7239]) into an array of objects.

## Install

```
npm install --save forwarded-parse
```

## API

This module exports a single function that takes a string and returns an array
of objects.

### `parse(text)`

#### Arguments

- `text` - The header field value.

#### Return value

An array of objects, one for each set of parameters added by a proxy.

#### Exceptions

Throws a `ParseError` exception if the header field value is invalid.

#### Example

```js
var parse = require('forwarded-parse');

console.log(
  parse('for=198.51.100.17;by=203.0.113.60;proto=http;host=example.com')
);

/*
[{
  for: '198.51.100.17',
  by: '203.0.113.60',
  proto: 'http',
  host: 'example.com'
}]
*/
```

## License

[MIT](LICENSE)

[npm-forwarded-parse-badge]: https://img.shields.io/npm/v/forwarded-parse.svg
[npm-forwarded-parse]: https://www.npmjs.com/package/forwarded-parse
[ci-forwarded-parse-badge]:
  https://img.shields.io/github/workflow/status/lpinca/forwarded-parse/CI/master?label=CI
[ci-forwarded-parse]:
  https://github.com/lpinca/forwarded-parse/actions?query=workflow%3ACI+branch%3Amaster
[coverage-forwarded-parse-badge]:
  https://img.shields.io/coveralls/lpinca/forwarded-parse/master.svg
[coverage-forwarded-parse]:
  https://coveralls.io/r/lpinca/forwarded-parse?branch=master
[rfc7239]: https://datatracker.ietf.org/doc/html/rfc7239

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