Skip to content

Commit 8c38707

Browse files
committed
docs(api): improve api docs
1 parent c83b333 commit 8c38707

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -82,32 +82,32 @@ server.on('request', (req, res) => {
8282

8383
#### web (req, res, options, onProxyError)
8484

85-
- `req`: `http.IncomingMessage` or `http2.Http2ServerRequest`
86-
- `res`: `http.ServerResponse` or `http2.Http2ServerResponse`
85+
- `req`: [`http.IncomingMessage`](https://nodejs.org/api/http.html#http_class_http_incomingmessage) or [`http2.Http2ServerRequest`](https://nodejs.org/api/http2.html#http2_class_http2_http2serverrequest)
86+
- `res`: [`http.ServerResponse`](https://nodejs.org/api/http.html#http_http_request_options_callback) or [`http2.Http2ServerResponse`](https://nodejs.org/api/http2.html#http2_class_http2_http2serverresponse)
8787
- `options`: see [Options](#options)
8888
- `onProxyError(err)`: called on error
8989

9090
#### ws (req, socket, head, options, onProxyError)
9191

92-
- `req`: `http.IncomingMessage`
93-
- `socket`: `net.Socket`
94-
- `head`: `Buffer`
92+
- `req`: [`http.IncomingMessage`](https://nodejs.org/api/http.html#http_class_http_incomingmessage)
93+
- `socket`: [`net.Socket`](https://nodejs.org/api/net.html#net_class_net_socket)
94+
- `head`: [`Buffer`](https://nodejs.org/api/buffer.html#buffer_class_buffer)
9595
- `options`: see [Options](#options)
9696
- `onProxyError(err)`: called on error
9797

9898
### Options
9999

100-
- `hostname`: target hostname
101-
- `port`: target port
102-
- `timeout`: incoming request timeout
103-
- `proxyTimeout`: proxy request timeout
100+
- `hostname`: proxy [`http.request(options)`](https://nodejs.org/api/http.html#http_http_request_options_callback) target hostname
101+
- `port`: proxy [`http.request(options)`](https://nodejs.org/api/http.html#http_http_request_options_callback) target port
102+
- `proxyTimeout`: proxy [`http.request(options)`](https://nodejs.org/api/http.html#http_http_request_options_callback) timeout
104103
- `proxyName`: proxy name used for **Via** header
104+
- `timeout`: [`http.IncomingMessage`](https://nodejs.org/api/http.html#http_class_http_incomingmessage) timeout
105105
- `onReq(req, options)`: called before proxy request
106-
- `req`: `http.IncomingMessage` or `http2.Http2ServerRequest`
107-
- `options`: options passed to `http.ClientRequest`
106+
- `req`: [`http.IncomingMessage`](https://nodejs.org/api/http.html#http_class_http_incomingmessage) or [`http2.Http2ServerRequest`](https://nodejs.org/api/http2.html#http2_class_http2_http2serverrequest)
107+
- `options`: options passed to [`http.request(options)`](https://nodejs.org/api/http.html#http_http_request_options_callback)
108108
- `onRes(req, res)`: called before proxy response
109-
- `req`: `http.IncomingMessage` or `http2.Http2ServerRequest`
110-
- `res`: `http.ServerResponse` or `http2.Http2ServerResponse`
109+
- `req`: [`http.IncomingMessage`](https://nodejs.org/api/http.html#http_class_http_incomingmessage) or [`http2.Http2ServerRequest`](https://nodejs.org/api/http2.html#http2_class_http2_http2serverrequest)
110+
- `res`: [`http.ServerResponse`](https://nodejs.org/api/http.html#http_http_request_options_callback) or [`http2.Http2ServerResponse`](https://nodejs.org/api/http2.html#http2_class_http2_http2serverresponse)
111111

112112
### License
113113

0 commit comments

Comments
 (0)