Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gr3p1p3 committed Apr 24, 2023
1 parent f5955e2 commit 261849d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,13 +219,19 @@ You can find an example [here](https://github.com/gr3p1p3/transparent-proxy/blob
The Session-Instance is an Object containing info/data about Tunnel.
It has following useful attributes and methods:

- isHttps - Is session encrypted.
- request - The Request-Object containing info about current request.
- response - The Response-Object containing info about current response.

- getTunnelStats() - Get Stats for this tunnel
- getId() - Get Own ID-Session
- isAuthenticated() - Is the session authenticated by user or not.
- {boolean} isHttps - Is session encrypted.
- {object} request - The Request-Object containing info about current request. Normally defined on both `injectData` & `injectResponse` Callbacks
- {object} request.headers - The intercepted request headers
- {string|undefined} [request.body] - The intercepted request body
- {object} response - The Response-Object containing info about current response. Normally defined on `injectResponse` Callback
- {object} response.headers - The intercepted response headers
- {string} response.body - The intercepted response body. It could be empty.
- {boolean} response.complete - is response completely done
- {buffer} rawResponse - The original body buffer.

- {object} getTunnelStats() - Get Stats for this tunnel
- {string} getId() - Get Own ID-Session
- {boolean} isAuthenticated() - Is the session authenticated by user or not.


## .getBridgedConnections()
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "transparent-proxy",
"version": "1.12.13",
"version": "1.12.14",
"description": "Real transparent HTTP-Proxy-Server. Upstream your requests whatever you want!",
"main": "ProxyServer.js",
"scripts": {
Expand Down

0 comments on commit 261849d

Please sign in to comment.