# forwarded

[![NPM Version](https://img.shields.io/npm/v/forwarded.svg)](https://npmjs.org/package/forwarded) [![NPM Downloads](https://img.shields.io/npm/dm/forwarded.svg)](https://npmjs.org/package/forwarded) [![Node.js Version](https://img.shields.io/node/v/forwarded.svg)](https://nodejs.org/en/download/) [![Build Status](https://badgen.net/github/checks/jshttp/forwarded/master?label=ci)](https://github.com/jshttp/forwarded/actions?query=workflow%3Aci) [![Test Coverage](https://img.shields.io/coveralls/jshttp/forwarded/master.svg)](https://coveralls.io/r/jshttp/forwarded?branch=master)

Parse HTTP X-Forwarded-For header

## Installation

This is a [Node.js](https://nodejs.org/en/) module available through the [npm registry](https://www.npmjs.com/). Installation is done using the [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):

```sh
$ npm install forwarded
```

## API

```js
var forwarded = require('forwarded')
```

### forwarded(req)

```js
var addresses = forwarded(req)
```

Parse the `X-Forwarded-For` header from the request. Returns an array of the addresses, including the socket address for the `req`, in reverse order (i.e. index `0` is the socket address and the last index is the furthest address, typically the end-user).

## Testing

```sh
$ npm test
```

## License

[MIT](https://github.com/pingponglabs/mediamagic-platform/blob/main/services/graphql-gateway/node_modules/forwarded/LICENSE/README.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mediamagic.dev/product-docs/services/graphql-gateway/node_modules/forwarded.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.