forwarded-parse

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


Keywords
forwarded, RFC-7239, RFC7239, header, parser, 7239, RFC
License
MIT
Install
npm install forwarded-parse@2.1.2

Documentation

forwarded-parse

Version npm Build Status Coverage Status

Parse the Forwarded header (RFC 7239) 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