Skip to content

Commit 9d9509f

Browse files
committed
[doc] Small update to code docs
1 parent 4f85ca0 commit 9d9509f

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

lib/node-http-proxy.js

+13
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,7 @@ HttpProxy.prototype.close = function () {
312312
// #### @req {ServerRequest} Incoming HTTP Request to proxy.
313313
// #### @res {ServerResponse} Outgoing HTTP Request to write proxied data to.
314314
// #### @options {Object} Options for the outgoing proxy request.
315+
//
315316
// options.port {number} Port to use on the proxy target host.
316317
// options.host {string} Host of the proxy target.
317318
// options.buffer {Object} Result from `httpProxy.buffer(req)`
@@ -552,6 +553,18 @@ HttpProxy.prototype._forwardRequest = function (req) {
552553
});
553554
};
554555

556+
//
557+
// ### function proxyWebSocketRequest (req, socket, head, options)
558+
// #### @req {ServerRequest} Websocket request to proxy.
559+
// #### @socket {net.Socket} Socket for the underlying HTTP request
560+
// #### @head {string} Headers for the Websocket request.
561+
// #### @options {Object} Options to use when proxying this request.
562+
//
563+
// options.port {number} Port to use on the proxy target host.
564+
// options.host {string} Host of the proxy target.
565+
// options.buffer {Object} Result from `httpProxy.buffer(req)`
566+
// options.https {Object|boolean} Settings for https.
567+
//
555568
HttpProxy.prototype.proxyWebSocketRequest = function (req, socket, head, options) {
556569
var self = this,
557570
listeners = {},

0 commit comments

Comments
 (0)