Skip to content

Commit

Permalink
Update docs, changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
evert committed Apr 25, 2022
1 parent b38358f commit 964be84
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,11 @@ properties and methods:
* `origin` - The 'origin' for the request, for example:
`http://my-api:8008`.
* `absoluteUrl` - The absolute URL for the request.
* `ip()` - Returns the ip address of the client. This may be ipv4 or ipv6.
If `CURVEBALL_TRUSTPROXY` is set in the environment and truthy, this will
use the information from the `X-Forwarded-For` header (if available).



### The Response interface

Expand Down
2 changes: 2 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Changelog
`Response` classes now have an extra constructor argument. This means
if you ever manually constructed any of these, there's a small change
you'll need to make. Typescript should point all these problems!
* If `CURVEBALL_TRUSTPROXY` is set, `request.ip()` will trust proxies
by default, and return the ip of the real client instead of the proxy.


0.18.0 (2022-04-16)
Expand Down

0 comments on commit 964be84

Please sign in to comment.