Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

forwarded

jshttp135mMIT0.2.0TypeScript support: definitely-typed

Parse HTTP X-Forwarded-For header

x-forwarded-for, http, req

readme

forwarded

NPM Version NPM Downloads Node.js Version Build Status Test Coverage

Parse HTTP X-Forwarded-For header

Installation

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install forwarded

API

var forwarded = require('forwarded')

forwarded(req)

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

$ npm test

License

MIT

changelog

0.2.0 / 2021-05-31

  • Use req.socket over deprecated req.connection

0.1.2 / 2017-09-14

  • perf: improve header parsing
  • perf: reduce overhead when no X-Forwarded-For header

0.1.1 / 2017-09-10

  • Fix trimming leading / trailing OWS
  • perf: hoist regular expression

0.1.0 / 2014-09-21

  • Initial release