forwarded-parse

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

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
forwarded-parse
1002.1.22 years ago9 years agoMinified + gzip package size for forwarded-parse in KB

Readme

forwarded-parse
!Version npmnpm-forwarded-parse-badgenpm-forwarded-parse !Build Statusci-forwarded-parse-badgeci-forwarded-parse !Coverage Statuscoverage-forwarded-parse-badgecoverage-forwarded-parse
Parse the Forwarded header (RFC 7239rfc7239) 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

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