Skip to content

Commit c018c77

Browse files
committed
update the doc about websocket proxy
1 parent 60bc149 commit c018c77

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

docs-src/cn/src_doc.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ const options = {
8484
},
8585
throttle: 10000,
8686
forceProxyHttps: false,
87+
wsIntercept: false, // 不开启websocket代理
8788
silent: false
8889
};
8990
const proxyServer = new AnyProxy.ProxyServer(options);
@@ -110,6 +111,7 @@ proxyServer.close();
110111
* `forceProxyHttps` {boolean} 是否强制拦截所有的https,忽略规则模块的返回,默认`false`
111112
* `silent` {boolean} 是否屏蔽所有console输出,默认`false`
112113
* `dangerouslyIgnoreUnauthorized` {boolean} 是否忽略请求中的证书错误,默认`false`
114+
* `wsIntercept` {boolean} 是否开启websocket代理,默认`false`
113115
* `webInterface` {object} web版界面配置
114116
* `enable` {boolean} 是否启用web版界面,默认`false`
115117
* `webPort` {number} web版界面端口号,默认`8002`

docs-src/en/src_doc.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ const options = {
8383
},
8484
throttle: 10000,
8585
forceProxyHttps: false,
86+
wsIntercept: false,
8687
silent: false
8788
};
8889
const proxyServer = new AnyProxy.ProxyServer(options);
@@ -106,11 +107,12 @@ proxyServer.close();
106107
* `port` {number} required, port number of proxy server
107108
* `rule` {object} your rule module
108109
* `throttle` {number} throttle in kb/s, unlimited for default
109-
* `forceProxyHttps` {boolean} in force intercept all https request, false for default
110-
* `silent` {boolean} if keep silent in console, false for default`false`
111-
* `dangerouslyIgnoreUnauthorized` {boolean} if ignore certificate error in request, false for default
110+
* `forceProxyHttps` {boolean} in force intercept all https request, default to `false`
111+
* `silent` {boolean} if keep silent in console, false for default `false`
112+
* `dangerouslyIgnoreUnauthorized` {boolean} if ignore certificate error in request, default to `false`
113+
* `wsIntercept` {boolean} whether to intercept websocket, default to `false`
112114
* `webInterface` {object} config for web interface
113-
* `enable` {boolean} if enable web interface, false for default
115+
* `enable` {boolean} if enable web interface, default to `false`
114116
* `webPort` {number} port number for web interface
115117
* Event: `ready`
116118
* emit when proxy server is ready

lib/requestHandler.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -570,7 +570,7 @@ function getConnectReqHandler(userRule, recorder, httpsServerMgr) {
570570
// determine the request target
571571
if (!shouldIntercept) {
572572
// server info from the original request
573-
const orginServer = {
573+
const originServer = {
574574
host,
575575
port: (targetPort === 80) ? 443 : targetPort
576576
}
@@ -581,7 +581,7 @@ function getConnectReqHandler(userRule, recorder, httpsServerMgr) {
581581
}
582582

583583
// for ws request, redirect them to local ws server
584-
return interceptWsRequest ? localHttpServer : orginServer;
584+
return interceptWsRequest ? localHttpServer : originServer;
585585
} else {
586586
return httpsServerMgr.getSharedHttpsServer(host).then(serverInfo => ({ host: serverInfo.host, port: serverInfo.port }));
587587
}

0 commit comments

Comments
 (0)