Firebase Update
This commit is contained in:
24
express-server/node_modules/proxy-addr/README.md
generated
vendored
24
express-server/node_modules/proxy-addr/README.md
generated
vendored
@ -20,6 +20,8 @@ $ npm install proxy-addr
|
||||
|
||||
## API
|
||||
|
||||
<!-- eslint-disable no-unused-vars -->
|
||||
|
||||
```js
|
||||
var proxyaddr = require('proxy-addr')
|
||||
```
|
||||
@ -32,15 +34,19 @@ The `trust` argument is a function that returns `true` if you trust
|
||||
the address, `false` if you don't. The closest untrusted address is
|
||||
returned.
|
||||
|
||||
<!-- eslint-disable no-undef -->
|
||||
|
||||
```js
|
||||
proxyaddr(req, function(addr){ return addr === '127.0.0.1' })
|
||||
proxyaddr(req, function(addr, i){ return i < 1 })
|
||||
proxyaddr(req, function (addr) { return addr === '127.0.0.1' })
|
||||
proxyaddr(req, function (addr, i) { return i < 1 })
|
||||
```
|
||||
|
||||
The `trust` arugment may also be a single IP address string or an
|
||||
array of trusted addresses, as plain IP addresses, CIDR-formatted
|
||||
strings, or IP/netmask strings.
|
||||
|
||||
<!-- eslint-disable no-undef -->
|
||||
|
||||
```js
|
||||
proxyaddr(req, '127.0.0.1')
|
||||
proxyaddr(req, ['127.0.0.0/8', '10.0.0.0/8'])
|
||||
@ -50,6 +56,8 @@ proxyaddr(req, ['127.0.0.0/255.0.0.0', '192.168.0.0/255.255.0.0'])
|
||||
This module also supports IPv6. Your IPv6 addresses will be normalized
|
||||
automatically (i.e. `fe80::00ed:1` equals `fe80:0:0:0:0:0:ed:1`).
|
||||
|
||||
<!-- eslint-disable no-undef -->
|
||||
|
||||
```js
|
||||
proxyaddr(req, '::1')
|
||||
proxyaddr(req, ['::1/128', 'fe80::/10'])
|
||||
@ -62,6 +70,8 @@ not have to specify both `::ffff:a00:1` and `10.0.0.1`.
|
||||
As a convenience, this module also takes certain pre-defined names
|
||||
in addition to IP addresses, which expand into IP addresses:
|
||||
|
||||
<!-- eslint-disable no-undef -->
|
||||
|
||||
```js
|
||||
proxyaddr(req, 'loopback')
|
||||
proxyaddr(req, ['loopback', 'fc00:ac:1ab5:fff::1/64'])
|
||||
@ -86,6 +96,8 @@ Return all the addresses of the request, optionally stopping at the
|
||||
first untrusted. This array is ordered from closest to furthest
|
||||
(i.e. `arr[0] === req.connection.remoteAddress`).
|
||||
|
||||
<!-- eslint-disable no-undef -->
|
||||
|
||||
```js
|
||||
proxyaddr.all(req)
|
||||
```
|
||||
@ -93,6 +105,8 @@ proxyaddr.all(req)
|
||||
The optional `trust` argument takes the same arguments as `trust`
|
||||
does in `proxyaddr(req, trust)`.
|
||||
|
||||
<!-- eslint-disable no-undef -->
|
||||
|
||||
```js
|
||||
proxyaddr.all(req, 'loopback')
|
||||
```
|
||||
@ -103,9 +117,11 @@ Compiles argument `val` into a `trust` function. This function takes
|
||||
the same arguments as `trust` does in `proxyaddr(req, trust)` and
|
||||
returns a function suitable for `proxyaddr(req, trust)`.
|
||||
|
||||
<!-- eslint-disable no-undef, no-unused-vars -->
|
||||
|
||||
```js
|
||||
var trust = proxyaddr.compile('localhost')
|
||||
var addr = proxyaddr(req, trust)
|
||||
var trust = proxyaddr.compile('loopback')
|
||||
var addr = proxyaddr(req, trust)
|
||||
```
|
||||
|
||||
This function is meant to be optimized for use against every request.
|
||||
|
Reference in New Issue
Block a user