Blame view

node_modules/forwarded/README.md 1.6 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
  # forwarded
  
  [![NPM Version][npm-image]][npm-url]
  [![NPM Downloads][downloads-image]][downloads-url]
  [![Node.js Version][node-version-image]][node-version-url]
  [![Build Status][travis-image]][travis-url]
  [![Test Coverage][coveralls-image]][coveralls-url]
  
  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](LICENSE)
  
  [npm-image]: https://img.shields.io/npm/v/forwarded.svg
  [npm-url]: https://npmjs.org/package/forwarded
  [node-version-image]: https://img.shields.io/node/v/forwarded.svg
  [node-version-url]: https://nodejs.org/en/download/
  [travis-image]: https://img.shields.io/travis/jshttp/forwarded/master.svg
  [travis-url]: https://travis-ci.org/jshttp/forwarded
  [coveralls-image]: https://img.shields.io/coveralls/jshttp/forwarded/master.svg
  [coveralls-url]: https://coveralls.io/r/jshttp/forwarded?branch=master
  [downloads-image]: https://img.shields.io/npm/dm/forwarded.svg
  [downloads-url]: https://npmjs.org/package/forwarded